Update DEV onboarding documentation #4215
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Because: - Some areas of these docs are unpolished - There are a significant number of skill-level assumptions made in these docs I've gone through the "Getting Started" docs in order and tried to address the things I felt were missing or unclear. Largely this was just adding a bit more context, but there were also some formatting tweaks. I'm not confident this covers everything I'd like to do for these docs, but it's a start. One of the things that frustrates me about this set of onboarding docs is a missing target audience. I think we are trying to target people who are familiar with GitHub and also those who are new to contributing to Open Source (as well as some who are new to Rails), but the docs seem to assume a significant amount of knowledge. I'd like to revisit that in the future.
rhymes
reviewed
Oct 3, 2019
There was a problem hiding this comment.
I've added a few notes, thanks @jacobherrington for going through the getting started!
rhymes
suggested changes
Oct 3, 2019
pr-triage
bot
added
PR: reviewed-changes-requested
pr-triage
bot
added
PR: unreviewed
benhalpern
approved these changes
Oct 3, 2019
pr-triage
bot
added
PR: reviewed-approved
pr-triage
bot
added
PR: merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this? (check all applicable)
Description
Because:
these docs
I've gone through the "Getting Started" docs in order and tried to
address the things I felt were missing or unclear. Largely this was just
adding a bit more context, but there were also some formatting tweaks.
I'm not confident this covers everything I'd like to do for these docs,
but it's a start. One of the things that frustrates me about this set of
onboarding docs is a missing target audience. I think we are trying to
target people who are familiar with GitHub and also those who are new to
contributing to Open Source (as well as some who are new to Rails), but
the docs seem to assume a significant amount of knowledge. I'd like to
revisit that in the future.
Related Tickets & Documents
Mobile & Desktop Screenshots/Recordings (if there are UI changes)
Added to documentation?
[optional] What gif best describes this PR or how it makes you feel?