Skip to content

Improving the onboarding experience for Docs Open source#111

Merged
simpsoka merged 39 commits intomainfrom
onboarding
Oct 7, 2020
Merged

Improving the onboarding experience for Docs Open source#111
simpsoka merged 39 commits intomainfrom
onboarding

Conversation

@simpsoka
Copy link
Copy Markdown

@simpsoka simpsoka commented Oct 5, 2020

This PR adds a few updates to two files that are all about onboarding for folks who are new to contributing to docs.github.com:

  1. Readme.md: https://github.com/github/docs/blob/9f62787550f024d56dbfde3c1146ba8f96115e09/README.md
  2. Contributing.md: https://github.com/github/docs/blob/9f62787550f024d56dbfde3c1146ba8f96115e09/CONTRIBUTING.md

The readme updates introduce a very simple get started and contribute flow. It highlights that you can start just from clicking a button on docs.github.com, and that contributions can be made without writing a line of code (issue or discussion)

If you want to do something a little more complex, then you’re directed to contributing.md. That file now has a Getting Started guide at the top (before the TOC, so you’re not distracted by other parts of the article that you might not need yet). The guide is all about the main flow of checking out issues, opening a PR, getting it reviewed, and then merged. It references information that’s further down in the doc.

I also removed the parts about git troubleshooting, and simplified that by including “tips for working with our codebase,” which links to a learning lab module about managing merge conflicts. Eventually, we will want to update the Getting started with Git and GitHub docs and link to them instead of Learning Lab.

@simpsoka simpsoka requested a review from janiceilene October 5, 2020 21:12
@simpsoka simpsoka requested a review from crichID October 6, 2020 00:01
@simpsoka simpsoka marked this pull request as ready for review October 6, 2020 00:04
Copy link
Copy Markdown
Contributor

@zeke zeke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for jumping in! This is looking good. I left some suggestions.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread README.md Outdated
Kathy Korevec and others added 6 commits October 5, 2020 17:34
Co-authored-by: Zeke Sikelianos <zeke@sikelianos.com>
Co-authored-by: Zeke Sikelianos <zeke@sikelianos.com>
Co-authored-by: Zeke Sikelianos <zeke@sikelianos.com>
Comment thread README.md Outdated
Comment thread README.md Outdated
Copy link
Copy Markdown
Contributor

@janiceilene janiceilene left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@simpsoka This looks wonderful, thank you so much for making these updates so quickly ⚡

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Kathy Korevec and others added 12 commits October 5, 2020 21:51
Co-authored-by: Janice <janiceilene@github.com>
Co-authored-by: Janice <janiceilene@github.com>
Co-authored-by: Janice <janiceilene@github.com>
Co-authored-by: Janice <janiceilene@github.com>
Co-authored-by: Janice <janiceilene@github.com>
Co-authored-by: Janice <janiceilene@github.com>
Co-authored-by: Janice <janiceilene@github.com>
Co-authored-by: Janice <janiceilene@github.com>
Co-authored-by: Janice <janiceilene@github.com>
Copy link
Copy Markdown
Contributor

@zeke zeke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@martinwoodward
Copy link
Copy Markdown
Contributor

This is looking MUCH better now.

One nit - I still think this section isn't particularly helpful and you'd be better pointing them to somewhere in the docs on how to clone locally from the command line. The in-product instructions you get in the clone button are the most helpful thing as you don't have all that YOUR-USERNAME thing and we have to miss a bunch of stuff here anyway if we were going to cover in that much detail like create a branch, commit the changes, pushing the code (having set up SSH keys or credential helpers etc).

image

@simpsoka
Copy link
Copy Markdown
Author

simpsoka commented Oct 6, 2020

Thanks, @martinwoodward! Just made the following update to simplify things regarding fork instructions (also added a line about why this is useful for developers as they're making changes).

CleanShot 2020-10-06 at 11 43 51@2x

@simpsoka simpsoka merged commit 5512239 into main Oct 7, 2020
@simpsoka simpsoka deleted the onboarding branch October 7, 2020 03:09
Octomerger pushed a commit that referenced this pull request Nov 30, 2020
jnidzwetzki referenced this pull request in jnidzwetzki/docs Oct 6, 2022
* Fixes to Actions documentation based on GitHub issues #110, #111, #112, #113, #114

* additional link fixes

* One more

Co-authored-by: Lana Brindley <github@lanabrindley.com>
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

Successfully merging this pull request may close these issues.

8 participants