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

Make a nixpkgs auto reply action for docs prs pointing to docs guidelines and specific contribution info #839

Open
lf- opened this issue Dec 15, 2023 · 2 comments
Labels
site Improvements to the site infrastructure or content presentation

Comments

@lf-
Copy link
Member

lf- commented Dec 15, 2023

Observations

Can be easy to put docs in the wrong place or in the wrong style for the place due to issues communicating our values for docs, and this has burned out at least one contributor this week.

Problem

Docs specific contribution info isn't surfaced when making docs affecting prs on Nix and nixpkgs.

Approaches

We could make an auto reply action that finds if it touches the right sub tree and adds a little message linking to the nix.dev docs contribution info.

Willing to help?

Yeah

Priorities

Add 👍 to issues you find important.

@lf- lf- added the site Improvements to the site infrastructure or content presentation label Dec 15, 2023
@fricklerhandwerk
Copy link
Collaborator

I suppose this could be solved by adding a link to the (ever-growing) Nixpkgs contribution guide.

@lf-
Copy link
Member Author

lf- commented Dec 15, 2023

I suppose this could be solved by adding a link to the (ever-growing) Nixpkgs contribution guide.

I think it would explicitly be made worse by doing that because that's already in the PR template and nobody reads it. The contribution guide is long and mostly explains how we use git, and even if people do read it, it's not getting across the vision stuff. We need to link to something which explains clearly where every docs type belongs and the overall vision of docs and a style guide, and explicitly doesn't explain git.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
site Improvements to the site infrastructure or content presentation
Projects
None yet
Development

No branches or pull requests

2 participants