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

Provide documentation on how to contribute to documentation #86

Open
mglaman opened this issue Apr 3, 2017 · 1 comment
Open

Provide documentation on how to contribute to documentation #86

mglaman opened this issue Apr 3, 2017 · 1 comment

Comments

@mglaman
Copy link
Collaborator

mglaman commented Apr 3, 2017

At the MidCamp sprints I noticed we could use a documentation guide on how to contribute to our documentation (META META)

Things:

  • Point out each page has an "Edit this page" link at top
  • State that they should have a GitHub account
  • Show how to edit within GitHub, that it will fork and open PR, how to finalize the creation of PR (it's a three step process.)
  • Provide links to ReST basics
  • State that images cannot be uploaded from main repo
    • Check if images can be uploaded in their own fork from the UI
    • State they'll have to clone locally and edit to change images / update them
  • Verify contributors can add new pages via the UI
  • State heavy additions might be best done by cloning down the repository
@AndyD328
Copy link
Contributor

AndyD328 commented Mar 7, 2018

Working on this, should have something in the next few days. I'll make a pr of how far I get if it's not complete then.

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