]> xenbits.xensource.com Git - people/gdunlap/governance.git/commitdiff
Clean up index page out/move-to-sphinx/v1
authorGeorge Dunlap <george.dunlap@citrix.com>
Thu, 10 Sep 2020 17:08:05 +0000 (18:08 +0100)
committerGeorge Dunlap <george.dunlap@citrix.com>
Fri, 11 Sep 2020 10:53:31 +0000 (11:53 +0100)
Get rid of "change this here" comments.

Break into two sections: "Regulations", which are rules, and "Guides",
which are suggestions.

Remove unused indexes.

Signed-off-by: George Dunlap <george.dunlap@citrix.com>
source/index.rst

index c8b45d85e343b4c18f12224c728719c567d590d6..c8c066ba664aa99cd971a8e269f61d187aae7c03 100644 (file)
@@ -1,24 +1,36 @@
 .. XenProject Governance documentation master file, created by
    sphinx-quickstart on Tue Sep  8 12:10:02 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
-Welcome to XenProject Governance's documentation!
-=================================================
+Welcome to XenProject's Governance Documents
+============================================
+
+The Regulations section contains documents
+that regulate the operation of the XenProject,
+including minimum acceptable behavior
+and possible responses to unacceptable behavior.
+The Guides section contains documents describing ideal behavior
+that we strive for as a community.
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: Regulations:
 
    code-of-conduct
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Guides:
+
    communication-guide
    code-review-guide
    communication-practice
    resolving-disagreement
 
-Indices and tables
-==================
+Other
+-----
+
+.. Comment out the index for now, but leave it here so we can think
+   about adding it back in later
+   * :ref:`genindex`
 
-* :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`