Populate the docs section of the new contrib structure (#1454)

* mark the plan page as an aside to the reviewer

* link to the internals section from the contrib mention of it

* contrib: populate the docs section

Also added a pull-request-lifecycle page to the Code section.

contrib/code/index.rst

@@ -13,7 +13,7 @@ Code contributions
 [We'll include code-focused content from the :ref:`main devguide page <devguide-main>`: Quick
 reference, Quick links, Proposing changes, and so on.]
 
-[The existing "CPython's internals" section of the devguide will be fully
+[The existing :ref:`internals` section of the devguide will be fully
 migrated into the Python repo.]
 
 
@@ -22,6 +22,7 @@ migrated into the Python repo.]
 
    setup
    git
+   pull-request-lifecycle
    developer-workflow
    testing
    development-tools

contrib/code/pull-request-lifecycle.rst

@@ -0,0 +1,21 @@
+.. _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.]

contrib/contrib-plan.rst

@@ -1,8 +1,8 @@
 .. _contrib-plan:
 
-================================
-Plan for the Contributor's Guide
-================================
+==================================
+[Plan for the Contributor's Guide]
+==================================
 
 .. important::
 

contrib/doc/devguide.rst

@@ -0,0 +1,12 @@
+==================================
+Helping with the Developer's Guide
+==================================
+
+.. important::
+
+   |draft|
+
+   |purpose|
+
+
+[This is the existing :ref:`devguide` page from the devguide.]

contrib/doc/help-documenting.rst

@@ -0,0 +1,12 @@
+==========================
+Helping with documentation
+==========================
+
+.. important::
+
+   |draft|
+
+   |purpose|
+
+
+[This is the existing :ref:`help-documenting` page from the devguide.]

contrib/doc/index.rst

@@ -9,10 +9,19 @@ Documentation contributions
    |purpose|
 
 
-* Lifecycle of a docs pull request
-* (pull in Documentation sections from devguide)
-* Rst/Sphinx bootcamp
-* Editorial Style Guide
-* Translation
-   - How to add a new language
-   - Tools and workflow
+[The main page for documentation contributors.]
+
+[We'll include docs-focused content from the :ref:`main devguide page <devguide-main>`: Quick
+reference, Quick links, and so on.]
+
+
+.. toctree::
+   :maxdepth: 5
+
+   start-documenting
+   help-documenting
+   style-guide
+   markup
+   pull-request-lifecycle
+   translating
+   devguide

contrib/doc/markup.rst

@@ -0,0 +1,12 @@
+=======================
+reStructuredText markup
+=======================
+
+.. important::
+
+   |draft|
+
+   |purpose|
+
+
+[This is the existing :ref:`markup` page from the devguide.]

contrib/doc/pull-request-lifecycle.rst

@@ -0,0 +1,21 @@
+.. _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.]

contrib/doc/start-documenting.rst

@@ -0,0 +1,12 @@
+===============
+Getting started
+===============
+
+.. important::
+
+   |draft|
+
+   |purpose|
+
+
+[This is the existing documentation :ref:`start-documenting` page from the devguide.]

contrib/doc/style-guide.rst

@@ -0,0 +1,12 @@
+===========
+Style guide
+===========
+
+.. important::
+
+   |draft|
+
+   |purpose|
+
+
+[This is the existing documentation :ref:`style-guide` page from the devguide.]

contrib/doc/translating.rst

@@ -0,0 +1,12 @@
+===========
+Translating
+===========
+
+.. important::
+
+   |draft|
+
+   |purpose|
+
+
+[This is the existing :ref:`translating` page from the devguide.]

internals/index.rst

@@ -1,3 +1,5 @@
+.. _internals:
+
 ===================
 CPython's internals
 ===================