From 20b2f1f0c0402f28b6dde1e8ff0c5416edb6d21e Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 30 Jun 2017 10:07:41 -0400 Subject: [PATCH] reorganize docs using the new standard layout Move the docs around a little to allow the new templated docs.o.o site link to things like the user and install guides in the expected location. Change-Id: I7f3b625c04aa6cd2a7ebe5f2ce4a398cf464b1cc Signed-off-by: Doug Hellmann --- doc/source/contributing.rst | 1 - doc/source/{ => contributor}/coding.rst | 2 +- doc/source/contributor/contributing.rst | 1 + doc/source/contributor/index.rst | 9 +++++++++ doc/source/index.rst | 20 ++++--------------- .../{installation.rst => install/index.rst} | 0 .../index.rst} | 0 .../{ => user}/examples/cleanup-servers.py | 0 .../{ => user}/examples/create-server-dict.py | 0 .../examples/create-server-name-or-id.py | 0 .../{ => user}/examples/debug-logging.py | 0 .../{ => user}/examples/find-an-image.py | 0 .../{ => user}/examples/http-debug-logging.py | 0 .../{ => user}/examples/munch-dict-object.py | 0 .../{ => user}/examples/normalization.py | 0 .../{ => user}/examples/server-information.py | 0 .../examples/service-conditional-overrides.py | 0 .../examples/service-conditionals.py | 0 doc/source/{ => user}/examples/strict-mode.py | 0 .../examples/upload-large-object.py | 0 .../{ => user}/examples/upload-object.py | 0 doc/source/{ => user}/examples/user-agent.py | 0 doc/source/user/index.rst | 19 ++++++++++++++++++ doc/source/{ => user}/logging.rst | 0 doc/source/{ => user}/microversions.rst | 0 doc/source/{ => user}/model.rst | 0 doc/source/{ => user}/multi-cloud-demo.rst | 2 +- doc/source/{ => user}/usage.rst | 0 28 files changed, 35 insertions(+), 19 deletions(-) delete mode 100644 doc/source/contributing.rst rename doc/source/{ => contributor}/coding.rst (98%) create mode 100644 doc/source/contributor/contributing.rst create mode 100644 doc/source/contributor/index.rst rename doc/source/{installation.rst => install/index.rst} (100%) rename doc/source/{releasenotes.rst => releasenotes/index.rst} (100%) rename doc/source/{ => user}/examples/cleanup-servers.py (100%) rename doc/source/{ => user}/examples/create-server-dict.py (100%) rename doc/source/{ => user}/examples/create-server-name-or-id.py (100%) rename doc/source/{ => user}/examples/debug-logging.py (100%) rename doc/source/{ => user}/examples/find-an-image.py (100%) rename doc/source/{ => user}/examples/http-debug-logging.py (100%) rename doc/source/{ => user}/examples/munch-dict-object.py (100%) rename doc/source/{ => user}/examples/normalization.py (100%) rename doc/source/{ => user}/examples/server-information.py (100%) rename doc/source/{ => user}/examples/service-conditional-overrides.py (100%) rename doc/source/{ => user}/examples/service-conditionals.py (100%) rename doc/source/{ => user}/examples/strict-mode.py (100%) rename doc/source/{ => user}/examples/upload-large-object.py (100%) rename doc/source/{ => user}/examples/upload-object.py (100%) rename doc/source/{ => user}/examples/user-agent.py (100%) create mode 100644 doc/source/user/index.rst rename doc/source/{ => user}/logging.rst (100%) rename doc/source/{ => user}/microversions.rst (100%) rename doc/source/{ => user}/model.rst (100%) rename doc/source/{ => user}/multi-cloud-demo.rst (99%) rename doc/source/{ => user}/usage.rst (100%) diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 8cb3146fe..000000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../CONTRIBUTING.rst \ No newline at end of file diff --git a/doc/source/coding.rst b/doc/source/contributor/coding.rst similarity index 98% rename from doc/source/coding.rst rename to doc/source/contributor/coding.rst index 778089e6d..739b319fa 100644 --- a/doc/source/coding.rst +++ b/doc/source/contributor/coding.rst @@ -73,7 +73,7 @@ All objects should be normalized. It is shade's purpose in life to make OpenStack consistent for end users, and this means not trusting the clouds to return consistent objects. There should be a normalize function in `shade/_normalize.py` that is applied to objects before returning them to -the user. See :doc:`model` for further details on object model requirements. +the user. See :doc:`../user/model` for further details on object model requirements. Fields should not be in the normalization contract if we cannot commit to providing them to all users. diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 000000000..b1cd2f37d --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1 @@ +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 000000000..b032c3728 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,9 @@ +========================= + Shade Contributor Guide +========================= + +.. toctree:: + :maxdepth: 2 + + contributing + coding diff --git a/doc/source/index.rst b/doc/source/index.rst index be106d6e2..850bcff37 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,25 +11,13 @@ Contents: .. toctree:: :maxdepth: 2 - installation - usage - logging - model - contributing - coding - microversions - releasenotes + install/index + user/index + contributor/index + releasenotes/index .. include:: ../../README.rst -Presentations -============= - -.. toctree:: - :maxdepth: 1 - - multi-cloud-demo - Indices and tables ================== diff --git a/doc/source/installation.rst b/doc/source/install/index.rst similarity index 100% rename from doc/source/installation.rst rename to doc/source/install/index.rst diff --git a/doc/source/releasenotes.rst b/doc/source/releasenotes/index.rst similarity index 100% rename from doc/source/releasenotes.rst rename to doc/source/releasenotes/index.rst diff --git a/doc/source/examples/cleanup-servers.py b/doc/source/user/examples/cleanup-servers.py similarity index 100% rename from doc/source/examples/cleanup-servers.py rename to doc/source/user/examples/cleanup-servers.py diff --git a/doc/source/examples/create-server-dict.py b/doc/source/user/examples/create-server-dict.py similarity index 100% rename from doc/source/examples/create-server-dict.py rename to doc/source/user/examples/create-server-dict.py diff --git a/doc/source/examples/create-server-name-or-id.py b/doc/source/user/examples/create-server-name-or-id.py similarity index 100% rename from doc/source/examples/create-server-name-or-id.py rename to doc/source/user/examples/create-server-name-or-id.py diff --git a/doc/source/examples/debug-logging.py b/doc/source/user/examples/debug-logging.py similarity index 100% rename from doc/source/examples/debug-logging.py rename to doc/source/user/examples/debug-logging.py diff --git a/doc/source/examples/find-an-image.py b/doc/source/user/examples/find-an-image.py similarity index 100% rename from doc/source/examples/find-an-image.py rename to doc/source/user/examples/find-an-image.py diff --git a/doc/source/examples/http-debug-logging.py b/doc/source/user/examples/http-debug-logging.py similarity index 100% rename from doc/source/examples/http-debug-logging.py rename to doc/source/user/examples/http-debug-logging.py diff --git a/doc/source/examples/munch-dict-object.py b/doc/source/user/examples/munch-dict-object.py similarity index 100% rename from doc/source/examples/munch-dict-object.py rename to doc/source/user/examples/munch-dict-object.py diff --git a/doc/source/examples/normalization.py b/doc/source/user/examples/normalization.py similarity index 100% rename from doc/source/examples/normalization.py rename to doc/source/user/examples/normalization.py diff --git a/doc/source/examples/server-information.py b/doc/source/user/examples/server-information.py similarity index 100% rename from doc/source/examples/server-information.py rename to doc/source/user/examples/server-information.py diff --git a/doc/source/examples/service-conditional-overrides.py b/doc/source/user/examples/service-conditional-overrides.py similarity index 100% rename from doc/source/examples/service-conditional-overrides.py rename to doc/source/user/examples/service-conditional-overrides.py diff --git a/doc/source/examples/service-conditionals.py b/doc/source/user/examples/service-conditionals.py similarity index 100% rename from doc/source/examples/service-conditionals.py rename to doc/source/user/examples/service-conditionals.py diff --git a/doc/source/examples/strict-mode.py b/doc/source/user/examples/strict-mode.py similarity index 100% rename from doc/source/examples/strict-mode.py rename to doc/source/user/examples/strict-mode.py diff --git a/doc/source/examples/upload-large-object.py b/doc/source/user/examples/upload-large-object.py similarity index 100% rename from doc/source/examples/upload-large-object.py rename to doc/source/user/examples/upload-large-object.py diff --git a/doc/source/examples/upload-object.py b/doc/source/user/examples/upload-object.py similarity index 100% rename from doc/source/examples/upload-object.py rename to doc/source/user/examples/upload-object.py diff --git a/doc/source/examples/user-agent.py b/doc/source/user/examples/user-agent.py similarity index 100% rename from doc/source/examples/user-agent.py rename to doc/source/user/examples/user-agent.py diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 000000000..0e576834a --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,19 @@ +================== + Shade User Guide +================== + +.. toctree:: + :maxdepth: 2 + + usage + logging + model + microversions + +Presentations +============= + +.. toctree:: + :maxdepth: 1 + + multi-cloud-demo diff --git a/doc/source/logging.rst b/doc/source/user/logging.rst similarity index 100% rename from doc/source/logging.rst rename to doc/source/user/logging.rst diff --git a/doc/source/microversions.rst b/doc/source/user/microversions.rst similarity index 100% rename from doc/source/microversions.rst rename to doc/source/user/microversions.rst diff --git a/doc/source/model.rst b/doc/source/user/model.rst similarity index 100% rename from doc/source/model.rst rename to doc/source/user/model.rst diff --git a/doc/source/multi-cloud-demo.rst b/doc/source/user/multi-cloud-demo.rst similarity index 99% rename from doc/source/multi-cloud-demo.rst rename to doc/source/user/multi-cloud-demo.rst index 7b584487f..fdd9dcb1b 100644 --- a/doc/source/multi-cloud-demo.rst +++ b/doc/source/user/multi-cloud-demo.rst @@ -7,7 +7,7 @@ walk through it like a presentation, install `presentty` and run: .. code:: bash - presentty doc/source/multi-cloud-demo.rst + presentty doc/source/user/multi-cloud-demo.rst The content is hopefully helpful even if it's not being narrated, so it's being included in the `shade` docs. diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst similarity index 100% rename from doc/source/usage.rst rename to doc/source/user/usage.rst