diff --git a/conf.py b/conf.py index cd846dd042..0cb17ca745 100644 --- a/conf.py +++ b/conf.py @@ -179,6 +179,56 @@ "tracker.rst": "triage/issue-tracker.rst", "gh-labels.rst": "triage/labels.rst", "triaging.rst": "triage/triaging.rst", + # Contributing guide draft pages + "contrib/code/git.rst": "getting-started/git-boot-camp.rst", + "contrib/code/pull-request-lifecycle.rst": "getting-started/pull-request-lifecycle.rst", + "contrib/code/setup.rst": "getting-started/setup-building.rst", + "contrib/code/testing.rst": "testing/index.rst", + "contrib/code/developer-workflow.rst": "developer-workflow/index.rst", + "contrib/code/index.rst": "index.rst", + "contrib/code/development-tools.rst": "development-tools/index.rst", + "contrib/doc/devguide.rst": "documentation/devguide.rst", + "contrib/doc/help-documenting.rst": "documentation/help-documenting.rst", + "contrib/doc/markup.rst": "documentation/markup.rst", + "contrib/doc/pull-request-lifecycle.rst": "getting-started/pull-request-lifecycle.rst", + "contrib/doc/start-documenting.rst": "documentation/start-documenting.rst", + "contrib/doc/style-guide.rst": "documentation/style-guide.rst", + "contrib/doc/translating.rst": "documentation/translations/index.rst", + "contrib/doc/index.rst": "documentation/index.rst", + "contrib/intro/index.rst": "index.rst", + "contrib/project/channels.rst": "developer-workflow/communication-channels.rst", + "contrib/project/conduct.rst": "index.rst", + "contrib/project/github.rst": "index.rst", + "contrib/project/governance.rst": "index.rst", + "contrib/project/roles.rst": "index.rst", + "contrib/project/generative-ai.rst": "getting-started/generative-ai.rst", + "contrib/project/outreach.rst": "index.rst", + "contrib/project/directory-structure.rst": "getting-started/setup-building.rst", + "contrib/project/index.rst": "index.rst", + "contrib/security.rst": "index.rst", + "contrib/triage/issue-tracker.rst": "triage/issue-tracker.rst", + "contrib/triage/labels.rst": "triage/labels.rst", + "contrib/triage/reviewing.rst": "triage/triaging.rst", + "contrib/triage/triage-team.rst": "triage/triage-team.rst", + "contrib/triage/triaging.rst": "triage/triaging.rst", + "contrib/triage/index.rst": "triage/index.rst", + "contrib/user-success.rst": "index.rst", + "contrib/core-team/committing.rst": "core-team/committing.rst", + "contrib/core-team/experts.rst": "core-team/experts.rst", + "contrib/core-team/index.rst": "core-team/index.rst", + "contrib/core-team/join-team.rst": "core-team/join-team.rst", + "contrib/core-team/motivations.rst": "core-team/motivations.rst", + "contrib/core-team/responsibilities.rst": "core-team/responsibilities.rst", + "contrib/core-team/team-log.rst": "core-team/team-log.rst", + "contrib/workflows/codespaces.rst": "getting-started/setup-building.rst", + "contrib/workflows/compile.rst": "getting-started/setup-building.rst", + "contrib/workflows/get-source.rst": "getting-started/setup-building.rst", + "contrib/workflows/index.rst": "getting-started/setup-building.rst", + "contrib/workflows/install-dependencies.rst": "getting-started/setup-building.rst", + "contrib/workflows/install-git.rst": "getting-started/setup-building.rst", + "contrib/workflows/regenerate.rst": "getting-started/setup-building.rst", + "contrib/workflows/troubleshooting.rst": "getting-started/setup-building.rst", + "contrib/index.rst": "index.rst", } intersphinx_mapping = { @@ -202,21 +252,6 @@ # prolog and epilogs rst_prolog = f""" -.. |draft| replace:: - This is part of a **Draft** of the Python Contributor's Guide. - Text in square brackets are notes about content to fill in. - Currently, the devguide and this new Contributor's Guide co-exist in the - repo. We are using Sphinx include directives to demonstrate the re-organization. - The final Contributor's Guide will replace the devguide with content in only one - place. - We welcome help with this! - -.. |purpose| replace:: - The :ref:`contrib-plan` page has more details about the current state of this draft - and **how you can help**. See more info about the Contributor Guide in the - discussion forum: `Refactoring the DevGuide`_. - -.. _Refactoring the DevGuide: https://discuss.python.org/t/refactoring-the-devguide-into-a-contribution-guide/63409 .. |main_version| replace:: {_main_version} diff --git a/contrib/code/developer-workflow.rst b/contrib/code/developer-workflow.rst deleted file mode 100644 index 416ca2c022..0000000000 --- a/contrib/code/developer-workflow.rst +++ /dev/null @@ -1,25 +0,0 @@ -==================== -Development workflow -==================== - -.. important:: - - |draft| - - |purpose| - -[This is the existing :ref:`dev-workflow` page from the devguide] - -.. toctree:: - :maxdepth: 5 - - ../../developer-workflow/communication-channels - ../../developer-workflow/development-cycle - ../../developer-workflow/stdlib - ../../developer-workflow/extension-modules - ../../developer-workflow/c-api - ../../developer-workflow/lang-changes - ../../developer-workflow/grammar - ../../developer-workflow/porting - ../../developer-workflow/sbom - ../../developer-workflow/psrt diff --git a/contrib/code/development-tools.rst b/contrib/code/development-tools.rst deleted file mode 100644 index 769bba2b06..0000000000 --- a/contrib/code/development-tools.rst +++ /dev/null @@ -1,19 +0,0 @@ -================= -Development tools -================= - -.. important:: - - |draft| - - |purpose| - -[This is the existing :ref:`development-tools` page from the devguide.] - -.. toctree:: - :maxdepth: 5 - - ../../development-tools/clinic/index - ../../development-tools/gdb - ../../development-tools/clang - ../../development-tools/warnings diff --git a/contrib/code/git.rst b/contrib/code/git.rst deleted file mode 100644 index 7c7aaa57b1..0000000000 --- a/contrib/code/git.rst +++ /dev/null @@ -1,11 +0,0 @@ -======== -Git tips -======== - -.. important:: - - |draft| - - |purpose| - -[More git help for advanced things needed by code contributors.] diff --git a/contrib/code/index.rst b/contrib/code/index.rst deleted file mode 100644 index 7680950663..0000000000 --- a/contrib/code/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. _c_code: - -================== -Code contributions -================== - -.. important:: - - |draft| - - |purpose| - -[The main page for code contributors.] - -[We'll include code-focused content from the :ref:`main devguide page `: Quick -reference, Quick links, Proposing changes, and so on.] - -[The existing :ref:`internals` section of the devguide will be fully -migrated into the Python repo.] - - -.. toctree:: - :maxdepth: 5 - - setup - git - pull-request-lifecycle - developer-workflow - testing - development-tools diff --git a/contrib/code/pull-request-lifecycle.rst b/contrib/code/pull-request-lifecycle.rst deleted file mode 100644 index 30c0fd5903..0000000000 --- a/contrib/code/pull-request-lifecycle.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _code-pull-request-lifecycle: - -====================== -Pull request lifecycle -====================== - -.. important:: - - |draft| - - |purpose| - - -[Details of pull requests for code contributions. The existing -:ref:`pull-request-lifecycle` page is long and includes many details. -Some only apply to code contributions, but many are common to all -contributions. Should we keep a common page, with extra steps here, or -should this page have all of the details even if they are duplicated -elsewhere?] - -[See :ref:`docs-pull-request-lifecycle` for the documentation half of this conundrum.] diff --git a/contrib/code/setup.rst b/contrib/code/setup.rst deleted file mode 100644 index 2d14bb0d91..0000000000 --- a/contrib/code/setup.rst +++ /dev/null @@ -1,12 +0,0 @@ -================== -Setup and building -================== - -.. important:: - - |draft| - - |purpose| - -[More setup and build instructions specifically for code contributors, building -on the basics from the :ref:`Getting Started ` section.] diff --git a/contrib/code/testing.rst b/contrib/code/testing.rst deleted file mode 100644 index 575d1477a4..0000000000 --- a/contrib/code/testing.rst +++ /dev/null @@ -1,20 +0,0 @@ -===================== -Testing and buildbots -===================== - -.. important:: - - |draft| - - |purpose| - -[This is the existing :ref:`testing` page from the devguide.] - -.. toctree:: - :maxdepth: 5 - - ../../testing/run-write-tests - ../../testing/silence-warnings - ../../testing/coverage - ../../testing/buildbots - ../../testing/new-buildbot-worker diff --git a/contrib/contrib-plan.rst b/contrib/contrib-plan.rst deleted file mode 100644 index 65e386e2b9..0000000000 --- a/contrib/contrib-plan.rst +++ /dev/null @@ -1,47 +0,0 @@ -.. _contrib-plan: - -================================== -[Plan for the Contributor's Guide] -================================== - -.. important:: - - |draft| - - |purpose| - -We are in the process of updating and refactoring the devguide to be a -Contributor's Guide. It will highlight the different kinds of contribution -possible, and how to succeed at each kind. - -Currently, the Contibutor's Guide is a draft in this new last section of the -devguide. We welcome feedback, but please understand that some of the current -content is moving or skeletal. - -Repo structure -============== - -While the reorganization is happening, we are keeping the old devguide as it -is. The new Contributor's Guide is represented in this last section, but will -eventually be the only content in the guide. To avoid copying content, we're -using Sphinx include directives to display existing devguide content in its new -Contributor's Guide location. That is not how the eventual Guide will be -built. Once we are ready to make the Contributor's Guide real, we will -rearrange content into its new location. - -How to help -=========== - -To help, you can: - -- `Write an issue`_ detailing a change you'd like to see here. -- `Make a pull request`_ in this repo to add content. -- Join us in the `Python Docs Discord`_ to collaborate with other docs-minded - community members. -- Get in touch with the `Docs Editorial Board`_ to discuss larger documentation - concerns. - -.. _Write an issue: https://github.com/python/devguide/issues -.. _Make a pull request: https://github.com/python/devguide/pulls -.. _Python Docs Discord: https://discord.gg/qcfPbnM2zH -.. _Docs Editorial Board: https://python.github.io/editorial-board/ diff --git a/contrib/core-team/committing.rst b/contrib/core-team/committing.rst deleted file mode 100644 index 5b639cd5a0..0000000000 --- a/contrib/core-team/committing.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. important:: - - |draft| - - |purpose| - - -[This is the existing core developers :ref:`committing` page from the devguide. We'll -adjust "core developer" to "core team" where appropriate.] - -.. include:: ../../core-team/committing.rst diff --git a/contrib/core-team/experts.rst b/contrib/core-team/experts.rst deleted file mode 100644 index aa16f10bd9..0000000000 --- a/contrib/core-team/experts.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. important:: - - |draft| - - |purpose| - - -[This is the existing core team :ref:`experts` page from the devguide.] - -.. include:: ../../core-team/experts.rst diff --git a/contrib/core-team/index.rst b/contrib/core-team/index.rst deleted file mode 100644 index 2ca21344b0..0000000000 --- a/contrib/core-team/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. important:: - - |draft| - - |purpose| - - -.. _c_core-team: - -========= -Core team -========= - -[This is mostly re-organized from the :ref:`core-team` section of the devguide] - -.. toctree:: - :maxdepth: 5 - - responsibilities - committing - experts - team-log - motivations - join-team diff --git a/contrib/core-team/join-team.rst b/contrib/core-team/join-team.rst deleted file mode 100644 index 932216f7c6..0000000000 --- a/contrib/core-team/join-team.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. important:: - - |draft| - - |purpose| - - -[This is the existing core team :ref:`join-core-team` page from the devguide.] - -.. include:: ../../core-team/join-team.rst diff --git a/contrib/core-team/motivations.rst b/contrib/core-team/motivations.rst deleted file mode 100644 index 38ba310236..0000000000 --- a/contrib/core-team/motivations.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. important:: - - |draft| - - |purpose| - - -[This is the existing core team :ref:`motivations` page from the devguide.] - -.. include:: ../../core-team/motivations.rst diff --git a/contrib/core-team/responsibilities.rst b/contrib/core-team/responsibilities.rst deleted file mode 100644 index d6902bd780..0000000000 --- a/contrib/core-team/responsibilities.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. important:: - - |draft| - - |purpose| - - -[This is the existing core team :ref:`responsibilities` page from the devguide.] - -.. include:: ../../core-team/responsibilities.rst diff --git a/contrib/core-team/team-log.rst b/contrib/core-team/team-log.rst deleted file mode 100644 index ecfe856a41..0000000000 --- a/contrib/core-team/team-log.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. important:: - - |draft| - - |purpose| - - -[This is the existing core team :ref:`team-log` page from the devguide.] - -.. include:: ../../core-team/team-log.rst diff --git a/contrib/doc/devguide.rst b/contrib/doc/devguide.rst deleted file mode 100644 index 2c83e52003..0000000000 --- a/contrib/doc/devguide.rst +++ /dev/null @@ -1,12 +0,0 @@ -================================== -Helping with the Developer's Guide -================================== - -.. important:: - - |draft| - - |purpose| - - -[This is the existing :ref:`devguide` page from the devguide.] diff --git a/contrib/doc/help-documenting.rst b/contrib/doc/help-documenting.rst deleted file mode 100644 index befb4b2461..0000000000 --- a/contrib/doc/help-documenting.rst +++ /dev/null @@ -1,12 +0,0 @@ -========================== -Helping with documentation -========================== - -.. important:: - - |draft| - - |purpose| - - -[This is the existing :ref:`help-documenting` page from the devguide.] diff --git a/contrib/doc/index.rst b/contrib/doc/index.rst deleted file mode 100644 index dc8ec93074..0000000000 --- a/contrib/doc/index.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _c_docs: - -=========================== -Documentation contributions -=========================== - -.. important:: - - |draft| - - |purpose| - - -[The main page for documentation contributors.] - -[We'll include docs-focused content from the :ref:`main devguide page `: Quick -reference, Quick links, and so on.] - - -.. toctree:: - :maxdepth: 5 - - start-documenting - help-documenting - style-guide - markup - pull-request-lifecycle - translating - devguide diff --git a/contrib/doc/markup.rst b/contrib/doc/markup.rst deleted file mode 100644 index 96b9faad5e..0000000000 --- a/contrib/doc/markup.rst +++ /dev/null @@ -1,12 +0,0 @@ -======================= -reStructuredText markup -======================= - -.. important:: - - |draft| - - |purpose| - - -[This is the existing :ref:`markup` page from the devguide.] diff --git a/contrib/doc/pull-request-lifecycle.rst b/contrib/doc/pull-request-lifecycle.rst deleted file mode 100644 index a62e637283..0000000000 --- a/contrib/doc/pull-request-lifecycle.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _docs-pull-request-lifecycle: - -====================== -Pull request lifecycle -====================== - -.. important:: - - |draft| - - |purpose| - - -[Details of pull requests for documentation contributions. The existing -:ref:`pull-request-lifecycle` page is long and includes many details. -Some only apply to code contributions, but many are common to all -contributions. Should we keep a common page, with documentation tweaks here, or -should this page have only the documentation details even if they are duplicated -elsewhere?] - -[See :ref:`code-pull-request-lifecycle` for the code half of this conundrum.] diff --git a/contrib/doc/start-documenting.rst b/contrib/doc/start-documenting.rst deleted file mode 100644 index c5cf96161b..0000000000 --- a/contrib/doc/start-documenting.rst +++ /dev/null @@ -1,12 +0,0 @@ -=============== -Getting started -=============== - -.. important:: - - |draft| - - |purpose| - - -[This is the existing documentation :ref:`start-documenting` page from the devguide.] diff --git a/contrib/doc/style-guide.rst b/contrib/doc/style-guide.rst deleted file mode 100644 index 87762f3e03..0000000000 --- a/contrib/doc/style-guide.rst +++ /dev/null @@ -1,12 +0,0 @@ -=========== -Style guide -=========== - -.. important:: - - |draft| - - |purpose| - - -[This is the existing documentation :ref:`style-guide` page from the devguide.] diff --git a/contrib/doc/translating.rst b/contrib/doc/translating.rst deleted file mode 100644 index baface2f0d..0000000000 --- a/contrib/doc/translating.rst +++ /dev/null @@ -1,12 +0,0 @@ -=========== -Translating -=========== - -.. important:: - - |draft| - - |purpose| - - -[This is the existing :ref:`translating` page from the devguide.] diff --git a/contrib/index.rst b/contrib/index.rst deleted file mode 100644 index 0e7c79ca19..0000000000 --- a/contrib/index.rst +++ /dev/null @@ -1,112 +0,0 @@ -.. _c_root: - -================================== -Python Contributor's Guide (draft) -================================== - -.. include:: /include/activate-tab.rst - -.. important:: - - |draft| - - |purpose| - - -[Open question: how to divide content between this Introduction and the -:ref:`introduction `?] - -This guide is a comprehensive resource for :ref:`contributing ` -to Python_ -- for both new and experienced contributors. It is :ref:`maintained -` by the same community that maintains Python. We welcome your -contributions to Python! - -We encourage everyone to contribute to Python. This guide should have -everything you need to get started and be productive. If you still have -questions after reviewing the material in this guide, the `Core Python -Mentorship`_ group is available to help you through the process. - -There are a number of ways to contribute including code, documentation, and -triaging issues. We've organized this guide to provide specifics based on the -type of activity you'll be engaged in. - - -Using this guide -================ - -We recommend reading this guide as needed. You can stop where you feel -comfortable and begin contributing immediately without reading and -understanding everything. If you do choose to skip around this guide, be aware -that it is written assuming preceding sections have been read so you may need -to backtrack to fill in missing concepts and terminology. - -No matter what kind of contribution you'll be making, you should start with -these common sections: - -* :ref:`c_intro` -* :ref:`c_project` - -Then choose a path based on your type of activity: - -*[The original table on the devguide home had a fourth column for Core -Developers. That made the table wider and more confusing. I don't think core -team members need a quick intro path since they will have been through the -devguide before.]* - -*[I haven't adjusted the links in the table yet other than to add a link to the -major section at the top of each column.]* - -.. list-table:: - :widths: 10 10 10 - :header-rows: 1 - - * - :ref:`Documentation ` - - :ref:`Code ` - - :ref:`Triaging ` - * - - * :ref:`docquality` - * :ref:`documenting` - * :ref:`style-guide` - * :ref:`rst-primer` - * :ref:`translating` - * :ref:`devguide` - - - * :ref:`setup` - * :ref:`help` - * :ref:`pullrequest` - * :ref:`runtests` - * :ref:`fixingissues` - * :ref:`communication` - * :ref:`gitbootcamp` - * :ref:`devcycle` - - - * :ref:`tracker` - * :ref:`triaging` - * :ref:`helptriage` - * :ref:`experts` - * :ref:`labels` - * :ref:`gh-faq` - * :ref:`triage-team` - -Core team members will find guidance in the :ref:`c_core-team` section. - -Contents -======== - -.. toctree:: - :maxdepth: 3 - - contrib-plan - intro/index - project/index - triage/index - doc/index - code/index - core-team/index - user-success - security - workflows/index - - -.. _Python: https://www.python.org/ -.. _Core Python Mentorship: https://www.python.org/dev/core-mentorship/ diff --git a/contrib/intro/index.rst b/contrib/intro/index.rst deleted file mode 100644 index 98fa30fc38..0000000000 --- a/contrib/intro/index.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. _c_intro: - -============ -Introduction -============ - -.. important:: - - |draft| - - |purpose| - - - -[Open question: how to divide content between this Introduction and the -:ref:`home page `?] - -Welcome! - -New to open source? -=================== - -Python is an open source project, with culture and techniques from the broader -open source world. You might find it helpful to read about open source in -general. A number of individuals from the Python community have contributed to -a series of excellent guides at `Open Source Guides -`__. - -Anyone will find the following guides useful: - -* `How to Contribute to Open Source `__ -* `Building Welcoming Communities `__ - - -Healthy collaboration -===================== - -[Importance of healthy inclusive collaboration] - -[While code is a large part of the project's success, project management, documentation, governance, sprint outreach, etc. matter.] - -[We respect the individual skills people bring to the project and strive to create and maintain a culture of inclusion.] - -About this guide -================ - -Types of contribution -===================== - -[Pathways for contributors] - -Helping with this guide -======================= diff --git a/contrib/project/channels.rst b/contrib/project/channels.rst deleted file mode 100644 index 711dbe5879..0000000000 --- a/contrib/project/channels.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. important:: - - |draft| - - |purpose| - - -====================== -Communication channels -====================== - -* Repos -* Discourse -* Discord -* Mailing lists (deprioritize) -* Where to get help diff --git a/contrib/project/conduct.rst b/contrib/project/conduct.rst deleted file mode 100644 index 37fe3bbfa7..0000000000 --- a/contrib/project/conduct.rst +++ /dev/null @@ -1,16 +0,0 @@ -=============== -Code of Conduct -=============== - -.. important:: - - |draft| - - |purpose| - - -[Brief summary of the code of conduct, with links to official source.] - -* Standard for communication -* How to report -* Enforcement details diff --git a/contrib/project/directory-structure.rst b/contrib/project/directory-structure.rst deleted file mode 100644 index 0cebb25f7f..0000000000 --- a/contrib/project/directory-structure.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. important:: - - |draft| - - |purpose| - -.. _c_directory_structure: - -=================== -Directory structure -=================== - -[This is the :ref:`build_directory_structure` section from the devguide.] - -.. include:: ../../getting-started/setup-building.rst - :start-after: c_directory_structure_start - :end-before: c_directory_structure_end diff --git a/contrib/project/generative-ai.rst b/contrib/project/generative-ai.rst deleted file mode 100644 index 6cb5b62ffc..0000000000 --- a/contrib/project/generative-ai.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. important:: - - |draft| - - |purpose| - - -[This is the existing :ref:`generative-ai` page from the devguide.] - -.. include:: ../../getting-started/generative-ai.rst diff --git a/contrib/project/github.rst b/contrib/project/github.rst deleted file mode 100644 index fe45c6b8b1..0000000000 --- a/contrib/project/github.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. important:: - - |draft| - - |purpose| - -====== -GitHub -====== - -[Where are the actual artifacts?] - -* Main CPython repos -* Core workflow repos -* Infrastructure repos diff --git a/contrib/project/governance.rst b/contrib/project/governance.rst deleted file mode 100644 index a4bc66ff1b..0000000000 --- a/contrib/project/governance.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. important:: - - |draft| - - |purpose| - - -========== -Governance -========== - -[How decisions are made, who is involved, how to participate.] - -Steering Council -================ - -Documentation Editorial Board -============================= - -Typing Council -============== - - -Others? -======= diff --git a/contrib/project/index.rst b/contrib/project/index.rst deleted file mode 100644 index 9d3c89b9a9..0000000000 --- a/contrib/project/index.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _c_project: - -=================== -The CPython project -=================== - -.. important:: - - |draft| - - |purpose| - - -[Give the reader an understanding of the project as a whole. What are the -moving parts, who is involved, how do they interact?] - -* Structure - -.. toctree:: - :maxdepth: 5 - - conduct - roles - governance - generative-ai.rst - github - directory-structure.rst - channels - outreach diff --git a/contrib/project/outreach.rst b/contrib/project/outreach.rst deleted file mode 100644 index d43aa8e9de..0000000000 --- a/contrib/project/outreach.rst +++ /dev/null @@ -1,12 +0,0 @@ -======== -Outreach -======== - -.. important:: - - |draft| - - |purpose| - - -* Sprints diff --git a/contrib/project/roles.rst b/contrib/project/roles.rst deleted file mode 100644 index 8336fe4651..0000000000 --- a/contrib/project/roles.rst +++ /dev/null @@ -1,17 +0,0 @@ -===== -Roles -===== - -.. important:: - - |draft| - - |purpose| - - -[Quick overview of the roles people play. Core team has its own section.] - -* Core team -* Triager -* Contributors - * types of contributions diff --git a/contrib/security.rst b/contrib/security.rst deleted file mode 100644 index db40b4a167..0000000000 --- a/contrib/security.rst +++ /dev/null @@ -1,13 +0,0 @@ -========================================= -Security and infrastructure contributions -========================================= - -.. important:: - - |draft| - - |purpose| - -* Security -* Infrastructure -* Core workflow diff --git a/contrib/triage/index.rst b/contrib/triage/index.rst deleted file mode 100644 index 0a547d9d77..0000000000 --- a/contrib/triage/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _c_triage: - -=================== -Issues and triaging -=================== - -.. toctree:: - :maxdepth: 5 - - issue-tracker - triaging - labels - reviewing - triage-team diff --git a/contrib/triage/issue-tracker.rst b/contrib/triage/issue-tracker.rst deleted file mode 100644 index a5777bc81d..0000000000 --- a/contrib/triage/issue-tracker.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. important:: - - |draft| - - |purpose| - -[This is the existing :ref:`issue-tracker` page from the devguide] - -.. include:: ../../triage/issue-tracker.rst diff --git a/contrib/triage/labels.rst b/contrib/triage/labels.rst deleted file mode 100644 index c364817333..0000000000 --- a/contrib/triage/labels.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. important:: - - |draft| - - |purpose| - -[This is the existing :ref:`labels` page from the devguide] - -.. include:: ../../triage/labels.rst diff --git a/contrib/triage/reviewing.rst b/contrib/triage/reviewing.rst deleted file mode 100644 index 060f6b78dd..0000000000 --- a/contrib/triage/reviewing.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. important:: - - |draft| - - |purpose| - - -========= -Reviewing -========= - -* How? Etiquette? -* How to request a review? diff --git a/contrib/triage/triage-team.rst b/contrib/triage/triage-team.rst deleted file mode 100644 index a9b59056a9..0000000000 --- a/contrib/triage/triage-team.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. important:: - - |draft| - - |purpose| - -[This is the existing :ref:`triage-team` page from the devguide] - -.. include:: ../../triage/triage-team.rst diff --git a/contrib/triage/triaging.rst b/contrib/triage/triaging.rst deleted file mode 100644 index 22e1ccc657..0000000000 --- a/contrib/triage/triaging.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. important:: - - |draft| - - |purpose| - -[This is the existing :ref:`triaging` page from the devguide] - -.. include:: ../../triage/triaging.rst diff --git a/contrib/user-success.rst b/contrib/user-success.rst deleted file mode 100644 index 2a9ef5d4e5..0000000000 --- a/contrib/user-success.rst +++ /dev/null @@ -1,14 +0,0 @@ -======================================= -Accessibility, design, and user success -======================================= - -.. important:: - - |draft| - - |purpose| - - -* Accessibility -* Design -* User success diff --git a/contrib/workflows/codespaces.rst b/contrib/workflows/codespaces.rst deleted file mode 100644 index eb97ef7c2a..0000000000 --- a/contrib/workflows/codespaces.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. important:: - - |draft| - - |purpose| - -.. _c_using_codespaces: - -======================= -Using GitHub Codespaces -======================= - -[This is the :ref:`using-codespaces` section from the devguide.] - -.. include:: ../../getting-started/setup-building.rst - :start-after: c_codespaces_start - :end-before: c_codespaces_end diff --git a/contrib/workflows/compile.rst b/contrib/workflows/compile.rst deleted file mode 100644 index 18157b717e..0000000000 --- a/contrib/workflows/compile.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. important:: - - |draft| - - |purpose| - -.. _c_compiling: - -================= -Compile and build -================= - -.. note:: - [This is the :ref:`compiling` section from the devguide. I think this page - is too long and could be split by build target, but we can leave that for a - later time.] - -.. include:: ../../getting-started/setup-building.rst - :start-after: c_compile_and_build_start - :end-before: c_compile_and_build_end - -.. include:: ../../links.rst diff --git a/contrib/workflows/get-source.rst b/contrib/workflows/get-source.rst deleted file mode 100644 index ed56fe4e12..0000000000 --- a/contrib/workflows/get-source.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. important:: - - |draft| - - |purpose| - -.. _c_checkout: - -=================== -Get the source code -=================== - -.. note:: - [This is the :ref:`checkout` section from the devguide. We might need to edit - it to clarify that some steps are only needed for code contribution.] - -.. include:: ../../getting-started/setup-building.rst - :start-after: c_get_source_code_start - :end-before: c_get_source_code_end diff --git a/contrib/workflows/index.rst b/contrib/workflows/index.rst deleted file mode 100644 index 2c6ccf2bc9..0000000000 --- a/contrib/workflows/index.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _c_workflows: - -========= -Workflows -========= - -.. important:: - - |draft| - - |purpose| - - -This section contains details of workflows needed for all kinds of -contribution. - -.. toctree:: - - install-git.rst - get-source.rst - install-dependencies.rst - compile.rst - regenerate.rst - troubleshooting.rst - codespaces.rst diff --git a/contrib/workflows/install-dependencies.rst b/contrib/workflows/install-dependencies.rst deleted file mode 100644 index 9a511c6da2..0000000000 --- a/contrib/workflows/install-dependencies.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. important:: - - |draft| - - |purpose| - -.. _c_build-dependencies: - -==================== -Install Dependencies -==================== - -[This is the :ref:`build-dependencies` section from the devguide.] - -.. include:: ../../getting-started/setup-building.rst - :start-after: c_install_dependencies_start - :end-before: c_install_dependencies_end diff --git a/contrib/workflows/install-git.rst b/contrib/workflows/install-git.rst deleted file mode 100644 index e3d738b2ac..0000000000 --- a/contrib/workflows/install-git.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. important:: - - |draft| - - |purpose| - -.. _c_vcsetup: - -=========== -Install Git -=========== - -[This is the :ref:`vcsetup` section from the devguide.] - -.. include:: ../../getting-started/setup-building.rst - :start-after: c_install_git_start - :end-before: c_install_git_end diff --git a/contrib/workflows/regenerate.rst b/contrib/workflows/regenerate.rst deleted file mode 100644 index b5bca7dca7..0000000000 --- a/contrib/workflows/regenerate.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. important:: - - |draft| - - |purpose| - -.. _c_regenerating: - -=============================== -Regenerating auto-created files -=============================== - -.. note:: - [These are two similar sections from the is the :ref:`setup-building` section from the devguide.] - -Regenerate ``configure`` -======================== - -.. include:: ../../getting-started/setup-building.rst - :start-after: c_regenerate_configure_start - :end-before: c_regenerate_configure_end - -Regenerate the ABI dump -======================= - -.. include:: ../../getting-started/setup-building.rst - :start-after: c_regenerate_abi_start - :end-before: c_regenerate_abi_end diff --git a/contrib/workflows/troubleshooting.rst b/contrib/workflows/troubleshooting.rst deleted file mode 100644 index 68aa801584..0000000000 --- a/contrib/workflows/troubleshooting.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. important:: - - |draft| - - |purpose| - -.. _c_build_troubleshooting: - -=========== -Install Git -=========== - -[This is the :ref:`build_troubleshooting` section from the devguide.] - -.. include:: ../../getting-started/setup-building.rst - :start-after: c_build_troubleshooting_start - :end-before: c_build_troubleshooting_end diff --git a/index.rst b/index.rst index d1369cac3c..d167e91527 100644 --- a/index.rst +++ b/index.rst @@ -310,7 +310,6 @@ Full table of contents core-team/index internals versions - contrib/index .. _Buildbot status: https://www.python.org/dev/buildbot/ .. _Misc directory: https://github.com/python/cpython/tree/main/Misc