Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change proposal process to require user docs upfront #506

Open
artursouza opened this issue Jun 18, 2024 · 7 comments
Open

Change proposal process to require user docs upfront #506

artursouza opened this issue Jun 18, 2024 · 7 comments

Comments

@artursouza
Copy link
Member

artursouza commented Jun 18, 2024

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
Copy link

elena-kolevska commented Jun 18, 2024

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
Copy link

+1 binding

1 similar comment
@artursouza
Copy link
Member Author

+1 binding

@mikeee
Copy link
Member

mikeee commented Jun 18, 2024

+1 binding

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

@artursouza
Copy link
Member Author

+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
Copy link
Member

+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
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants