search

dapr / community

Governance and community material for Dapr and its open source sub-projects
Apache License 2.0
149 stars 65 forks source link

Change proposal process to require user docs upfront #506

Open artursouza opened 4 months ago

artursouza commented 4 months ago

There are many good discussions that comes from discussing docs AFTER the feature is implemented, requiring sometimes significant changes. To avoid this rework, we should include the user docs draft pull request WITH the proposal, BEFORE it is approved.

Please, vote: 👍 or 👎

Binding votes (maintainers), please also comment.

elena-kolevska commented 4 months ago

I believe this is a good approach because it's developer-centric and has a high potential to attract more input from the community. It also makes our documentation a first-class citizen.

JoshVanL commented 4 months ago

+1 binding

artursouza commented 4 months ago

+1 binding

mikeee commented 4 months ago

+1 binding

Should this be in the form of a PR to the proposals repo?

artursouza commented 4 months ago

+1 binding

Should this be in the form of a PR to the proposals repo?

Yes, I will make a PR after this is approved.

berndverst commented 4 months ago

+1 binding

For clarification: This proposal is only about authoring proposals. The change is to require drafts of the user facing docs (as draft docs PRs). That's a good enhancement. Without such docs it's often not clear how a proposal will work in practice.

msfussell commented 3 months ago

+1 binding. @artursouza - Can you raise a PR for this now?