search

writethedocs / www

The main website for Write the Docs.
http://www.writethedocs.org
Other
1.32k stars 511 forks source link

Merge contribution content #2170

Closed stumblefiend closed 2 months ago

stumblefiend commented 3 months ago

This pull request updates the git instructions to match the current GitHub UI and clarifies whether the steps should be performed in a terminal, github website, or some other app.

The other purpose of this pull request is to merge our contribution content. We don't rank in SEO for "learning git" and it probably isn't a good use of our time to try. Also, combining the two main contribution pages serves our audience better by providing one comprehensive guide that contains everything they need to know (especially if they are a beginner) about how to contribute to Write the Docs guides.

There are plenty of guides about learning git online and guides that explain the basic workflow of clone, edit, stage, add, commit, and push. In fact, I should update this PR with a link to the most authoritative and helpful guide explaining the basic git workflow.

If we want to later revisit creating a separate page about git, we should make it unique, relevant, and relatable to our audience of documentarians (for instance, a topic on integrating git with documentation tools). However, for basic git workflows that talk specifically about how to update the content of the Write the Docs website, these types of instructions better serve the community by existing in the contribution content itself.

stumblefiend commented 3 months ago

Where should "contacting one of the guide editors" link to?

stumblefiend commented 3 months ago

I'll check back on the build status later and make fixes, but at least this PR is up to already start gathering thoughts and feedback.

stumblefiend commented 2 months ago

OK, I went inside the build and clicked all the links as a last precaution. Looks like everything links to where it should.

@plaindocs this PR is also ready for final review and approval.