contrib: restructure Getting Started - Setup and Building into a Workflows section #1467
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
This makes it easier to move content around without worrying about where the links are defined. It will also be easier to have canonical links that can be used from multiple places in the guide.
…flows section The Getting Started section has a lot of technical detail. I thought it would be better moved to the end, and referenced from the contribution paths earlier in the guide. I haven't updated the paths yet. Also: - I added a central links.rst that can be included anywhere. - I omitted the "Editors and tools" section. It doesn't provide any useful information. - Perhaps the Workflows section could be further categorized. - The `c_blah_start` and `c_blah_end` comments are only for the temporary inclusions being used to demonstrate the new organization.
|
@nedbat I did a quick scan and looked good. I'm traveling tomorrow so can look more closely then. |
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.
The Getting Started section has a lot of technical detail. I thought it
would be better moved to the end, and referenced from the contribution
paths earlier in the guide. I haven't updated the paths yet.
Also:
c_blah_startandc_blah_endcomments are only for the temporary inclusions being used to demonstrate the new organization.📚 Documentation preview 📚: https://cpython-devguide--1467.org.readthedocs.build/