Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

contrib: restructure Getting Started - Setup and Building into a Workflows section #1466

Closed
wants to merge 5 commits into from

Conversation

nedbat
Copy link
Member

@nedbat nedbat commented Nov 4, 2024

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.

📚 Documentation preview 📚: https://cpython-devguide--1466.org.readthedocs.build/

Copy link

cpython-cla-bot bot commented Nov 4, 2024

All commit authors signed the Contributor License Agreement.
CLA signed

@nedbat nedbat requested review from hugovk and willingc November 4, 2024 14:45
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
Copy link
Member Author

nedbat commented Nov 4, 2024

Hmm, not sure how [email protected] was the author of a few commits, but I've fixed them.

@nedbat nedbat closed this Nov 4, 2024
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.

1 participant