diff --git a/conf.py b/conf.py index 40b3e1adda..1535ebfa00 100644 --- a/conf.py +++ b/conf.py @@ -187,11 +187,11 @@ We welcome help with this! .. |purpose| replace:: - See more info about the Contributor Guide in the discussion forum: `Refactoring the DevGuide`_. - Questions? Ask the `Docs Editorial Board`_. + 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 -.. _Docs Editorial Board: https://python.github.io/editorial-board/ """ diff --git a/contrib/contrib-plan.rst b/contrib/contrib-plan.rst new file mode 100644 index 0000000000..be35c1a8db --- /dev/null +++ b/contrib/contrib-plan.rst @@ -0,0 +1,47 @@ +.. _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/NeGgyhUZ +.. _Docs Editorial Board: https://python.github.io/editorial-board/ diff --git a/contrib/index.rst b/contrib/index.rst index 43dc52d746..1c169ffbeb 100644 --- a/contrib/index.rst +++ b/contrib/index.rst @@ -15,9 +15,16 @@ This guide is a comprehensive resource for contributing to Python. This is a draft of a new organization for the devguide, turning it into a Contributor's Guide. +[Much of the devguide home page will be here. The Quick Start will be updated +to distinguish code vs documentation contributions, and moved to those +sections. Other changes will be made to explain the different types of +contribution and how to navigate the guide for your own type.] + + .. toctree:: :maxdepth: 2 + contrib-plan intro/index project/index get-started/index