docs on compiling: friendlier to first-time contributors #72166
Merged
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.
Summary
None
Purpose of change
While helping a first-time contributor making PR #72153, some issues in docs became apparent. Not mentioning git led the poor soul to think there is no more to be done with git than to
git clone
so they got stuck atgit push
. It turned out, they didn't even make a fork.I also saw some inconsistencies and things I thought could be improved (after my changes, it is subjectively better).
Describe the solution
Directly regarding the conversation with the first-time contributor
Furthermore
Note:
marker as I feel it is the core of the text.Describe alternatives you've considered
Also, look for mentions that CDDA with history is 3GB. Replace them with the fact it is 6GB today.
Testing
Compiled the .MD file locally into HTML and click the links.
Additional context