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

Add specific contribution guidelines for documentation #817

Closed
sgibson91 opened this issue Apr 2, 2019 · 3 comments
Closed

Add specific contribution guidelines for documentation #817

sgibson91 opened this issue Apr 2, 2019 · 3 comments

Comments

@sgibson91
Copy link
Member

This was an idea that came out of a documentation workshop at the Collaborations Workshop run by the Software Sustainability Institute.

For new users coming to contribute to a project, they are the mostly likely candidates to find gaps in your documentation and potentially come up with solutions to these gaps. Therefore, I'm proposing a section in CONTRIBUTING.md that outlines the process by which to update the docs, including:

  • opening an issue to discuss the change or document the knowledge gap if they themselves can't fill it
  • where do the sources files for the docs live
    • this may include an "improve this page" style link on the host website which links to the repo, distinct from the "Page source" link currently implemented
  • how to locally compile the docs to preview your changes before making a pull request

I hope you think this is a good idea, I think it will encourage even more people to get involved! :)

@sgibson91
Copy link
Member Author

This could probably just be a summary of the Jupyter contribution guidelines for documentation with the specific make command to locally compile 😄

@betatim
Copy link
Member

betatim commented Apr 2, 2019

I think this is a great idea! I think we should have a short version of this guide in https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md which describes the steps you mentioned with the commands you can copy&paste. And then a link to the longer version at https://jupyter.readthedocs.io/en/latest/contrib_docs/index.html.

Even as an experienced contributor I find the full version quite overwhelming and "oh my god where do i even start?" where as if you give me a bullet point list with ten steps that fits on one screen I am "ok, easy peasy, this will take 5minutes" (even though it usually takes longer, but at least I get started).

@sgibson91
Copy link
Member Author

@betatim I think you addressed this in #824 and can be closed

@betatim betatim closed this as completed May 10, 2019
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

2 participants