All of lore.kernel.org
 help / color / mirror / Atom feed
From: George Dunlap <george.dunlap@citrix.com>
To: <xen-devel@lists.xenproject.org>
Cc: George Dunlap <george.dunlap@citrix.com>
Subject: [PATCH 8/8] Clean up index page
Date: Fri, 11 Sep 2020 13:40:09 +0100	[thread overview]
Message-ID: <20200911124009.3760032-9-george.dunlap@citrix.com> (raw)
In-Reply-To: <20200911124009.3760032-1-george.dunlap@citrix.com>

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 | 26 +++++++++++++++++++-------
 1 file changed, 19 insertions(+), 7 deletions(-)

diff --git a/source/index.rst b/source/index.rst
index c8b45d8..41f92fb 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -1,16 +1,26 @@
 .. 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
@@ -19,6 +29,8 @@ Welcome to XenProject Governance's documentation!
 Indices and tables
 ==================
 
-* :ref:`genindex`
-* :ref:`modindex`
+.. Comment out the index for now, but leave it here so we can think
+   about adding it back in later
+   * :ref:`genindex`
+
 * :ref:`search`
-- 
2.24.3 (Apple Git-128)



  parent reply	other threads:[~2020-09-11 12:40 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-11 12:40 [PATCH 0/8] Finding a home for the Code of Conduct George Dunlap
2020-09-11 12:40 ` [PATCH 1/8] Add basic sphinx structure George Dunlap
2020-09-11 12:40 ` [PATCH 2/8] Move docs into source directory, rename to rst George Dunlap
2020-09-11 12:40 ` [PATCH 3/8] Convert code-of-conduct " George Dunlap
2020-09-11 13:39   ` Jürgen Groß
2020-09-11 13:45     ` George Dunlap
2020-09-11 12:40 ` [PATCH 4/8] Convert communication-guide.md " George Dunlap
2020-09-11 12:40 ` [PATCH 5/8] Convert code-review-guide.md " George Dunlap
2020-09-11 12:40 ` [PATCH 6/8] Convert communication-practice.md to RST George Dunlap
2020-09-11 12:40 ` [PATCH 7/8] Convert resolving-disagreement.md to rst George Dunlap
2020-09-11 12:40 ` George Dunlap [this message]
2020-09-11 16:50 ` [PATCH 0/8] Finding a home for the Code of Conduct Stefano Stabellini
2020-09-14  9:41   ` George Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200911124009.3760032-9-george.dunlap@citrix.com \
    --to=george.dunlap@citrix.com \
    --cc=xen-devel@lists.xenproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.