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

Reorganise the devguide to directories #895

Closed
wants to merge 1,519 commits into from
Closed

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Jun 14, 2022

From the discord discussion, this is an attempt to add some structure to Docs/Tests/Triage and clean up the top level.

No content has been edited, except for combing two duplicated "how to become a triager" sections. As I moved content between pages I had to edit the underlines -- I also standardised some ^ underlines and out-of-order underlines to allow easier page moves in the future (e.g. a core-dev folder, buildbots, language design and change).

cc: @ezio-melotti @encukou @CAM-Gerlach

Preview: https://cpython-devguide--895.org.readthedocs.build/

A

brettcannon and others added 30 commits February 28, 2020 15:35
…thonGH-588)


Co-authored-by: Kyle Stanley <aeros167@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
* Explicitly mention the preference for imperative over descriptive titles
* Link to the article from Chris Beams
Co-authored-by: Manuel Jacob <test>
Re-apply commit 0427168.
This time the issue was fixed in the script that generates the data,
so it shouldn't reappear.

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Spanish translation of Python documentation is located at new repository under `python` organization.
…sh docs translations (python#607)

Remove e-mail link

Co-authored-by: Maciej Olko <maciej.olko@yougov.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
…#598)

Try to be more consistent about use of major.minor.micro version
numbers and of feature, bugfix, and security releases.  Reflect
current policy and practice for branch transitions as of 3.9.
Other minor cleanups.
* help: Add link to Discourse instance

Add note that IRC channel may not have history, and thus may not be easily searchable for newcomers.
(I could not easily find a discussion archive)

* Address Mariatta's comments
@hugovk
Copy link
Member

hugovk commented Jun 16, 2022

Currently there is a bent towards joinedupwords, but garbage_collector, c-api, and gh-(faq|labels) are exceptions. I'd suggest preferring some form of spacing character for filenames of more than two words, and potentially for filenames of two words.

Let's use a hyphen, because you can use alt+arrow key (on Mac, ctrl+arrow on Windows?) to jump between words. Underscore is treated as a letter.

@CAM-Gerlach
Copy link
Member

Implemented all your other changes (I went with a slightly different title for a few files).

Thanks so much, much appreciated! 🎉

What filenames would you suggest?

This is what I would suggest, following the discussion above (you could add ref aliases for the new names, but leave the existing ones obv). The main intent is to more helpfully describe the document's contents, clearly disambiguate it from others and ensure it is a good match for the document title, to aid navigating to/linking the correct one in the source.

Filename suggestions here

Core dev:

  • committing -> accepting-prs
  • coredev -> becoming-coredev
  • developers -> developer-log

Development workflow:

  • communication -> communication-channels
  • devcycle -> dev-cycle
  • extensions -> extension-modules
  • langchanges -> lang-changes
  • stdlibchanges -> stdlib (to parallel extensions)

CPython's internels:

  • garbage_collector -> garbage-collector

Getting Started:

  • fixingissues -> fixing-issues
  • gitbootcamp -> git-bootcamp
  • help -> getting-help
  • pullrequest -> pull-request-lifecycle
  • setup -> setup-building

Testing:

  • buildworker -> setup-new-buildbot
  • runtests -> run-write-tests
  • silencewarnings -> silence-warnings

Triaging:

  • tracker -> issue-tracker
  • triageteam -> triage-team

Currently there is a bent towards joinedupwords, but garbage_collector, c-api, and gh-(faq|labels) are exceptions. I'd suggest preferring some form of spacing character for filenames of more than two words, and potentially for filenames of two words.

Definitely agreed (was going to go with -), that's a significant part of what I was thinking as it greatly improves readability.

Let's use a hyphen, because you can use alt+arrow key (on Mac, ctrl+arrow on Windows?) to jump between words. Underscore is treated as a letter.

My plans as well 👍

@AA-Turner
Copy link
Member Author

Clearly I messed something up when pushing after doing the filter-repo steps, I thought I'd rebased on upstream properly to retain the history. GitHub won't let me re-open the PR, so opening a new one.

A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.