From f86cc2fc8ebd12ed98a72f93b29506a0a8d433f6 Mon Sep 17 00:00:00 2001
From: Brian Curtin <brian.curtin@rackspace.com>
Date: Fri, 30 Jan 2015 15:36:14 -0600
Subject: [PATCH] Reorganize existing documentation files
This change creates two directories of content, based on who they're
relevant to: users and contributors. Files which were in the top-level
folder were moved, as well as some within folders in that top-level.
This is one change of a multi-step process, so it only deals with
renamings in order to make further changes cleaner.
Change-Id: I3c9bb7da4f283e2696e7bcea84824c778bbcecfb
Partial-Bug: 1416553
---
.../{ => contributors}/contributing.rst | 0
doc/source/index.rst | 36 +++++++++----------
doc/source/{ => users}/base_auth_plugin.rst | 0
doc/source/{ => users}/connection.rst | 0
doc/source/{ => users}/glossary.rst | 0
.../{ => users}/highlevel/object_store.rst | 2 +-
doc/source/{ => users}/identity_base.rst | 0
doc/source/{ => users}/identity_v2.rst | 0
doc/source/{ => users}/identity_v3.rst | 0
doc/source/{ => users}/installation.rst | 0
doc/source/{ => users}/resource.rst | 0
.../resources/object_store/v1/container.rst | 0
.../resources/object_store/v1/obj.rst | 0
doc/source/{ => users}/service_filter.rst | 0
doc/source/{ => users}/session.rst | 0
doc/source/{ => users}/transport.rst | 0
doc/source/{ => users}/usage.rst | 0
doc/source/{ => users}/user_preference.rst | 0
.../{ => users}/userguides/object_store.rst | 0
19 files changed, 19 insertions(+), 19 deletions(-)
rename doc/source/{ => contributors}/contributing.rst (100%)
rename doc/source/{ => users}/base_auth_plugin.rst (100%)
rename doc/source/{ => users}/connection.rst (100%)
rename doc/source/{ => users}/glossary.rst (100%)
rename doc/source/{ => users}/highlevel/object_store.rst (81%)
rename doc/source/{ => users}/identity_base.rst (100%)
rename doc/source/{ => users}/identity_v2.rst (100%)
rename doc/source/{ => users}/identity_v3.rst (100%)
rename doc/source/{ => users}/installation.rst (100%)
rename doc/source/{ => users}/resource.rst (100%)
rename doc/source/{ => users}/resources/object_store/v1/container.rst (100%)
rename doc/source/{ => users}/resources/object_store/v1/obj.rst (100%)
rename doc/source/{ => users}/service_filter.rst (100%)
rename doc/source/{ => users}/session.rst (100%)
rename doc/source/{ => users}/transport.rst (100%)
rename doc/source/{ => users}/usage.rst (100%)
rename doc/source/{ => users}/user_preference.rst (100%)
rename doc/source/{ => users}/userguides/object_store.rst (100%)
diff --git a/doc/source/contributing.rst b/doc/source/contributors/contributing.rst
similarity index 100%
rename from doc/source/contributing.rst
rename to doc/source/contributors/contributing.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index c2b97e2c4..d90a7fa1e 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -6,10 +6,10 @@ Welcome!
.. toctree::
:maxdepth: 2
- installation
- usage
- contributing
- glossary
+ users/installation
+ users/usage
+ contributors/contributing
+ users/glossary
User Guides
-----------
@@ -17,7 +17,7 @@ User Guides
.. toctree::
:maxdepth: 1
- userguides/object_store
+ users/userguides/object_store
High-Level Interface
--------------------
@@ -25,7 +25,7 @@ High-Level Interface
.. toctree::
:maxdepth: 1
- highlevel/object_store
+ users/highlevel/object_store
Resource Level Classes
----------------------
@@ -33,8 +33,8 @@ Resource Level Classes
.. toctree::
:maxdepth: 1
- resources/object_store/v1/container
- resources/object_store/v1/obj
+ users/resources/object_store/v1/container
+ users/resources/object_store/v1/obj
Low-Level Classes
-----------------
@@ -42,13 +42,13 @@ Low-Level Classes
.. toctree::
:maxdepth: 1
- connection
- user_preference
- session
- transport
- base_auth_plugin
- identity_base
- identity_v2
- identity_v3
- resource
- service_filter
+ users/connection
+ users/user_preference
+ users/session
+ users/transport
+ users/base_auth_plugin
+ users/identity_base
+ users/identity_v2
+ users/identity_v3
+ users/resource
+ users/service_filter
diff --git a/doc/source/base_auth_plugin.rst b/doc/source/users/base_auth_plugin.rst
similarity index 100%
rename from doc/source/base_auth_plugin.rst
rename to doc/source/users/base_auth_plugin.rst
diff --git a/doc/source/connection.rst b/doc/source/users/connection.rst
similarity index 100%
rename from doc/source/connection.rst
rename to doc/source/users/connection.rst
diff --git a/doc/source/glossary.rst b/doc/source/users/glossary.rst
similarity index 100%
rename from doc/source/glossary.rst
rename to doc/source/users/glossary.rst
diff --git a/doc/source/highlevel/object_store.rst b/doc/source/users/highlevel/object_store.rst
similarity index 81%
rename from doc/source/highlevel/object_store.rst
rename to doc/source/users/highlevel/object_store.rst
index 8f46216c3..a4a8ea1ae 100644
--- a/doc/source/highlevel/object_store.rst
+++ b/doc/source/users/highlevel/object_store.rst
@@ -1,7 +1,7 @@
Object Store API
================
-For details on how to use this API, see :doc:`/userguides/object_store`
+For details on how to use this API, see :doc:`/users/userguides/object_store`
.. automodule:: openstack.object_store.v1._proxy
diff --git a/doc/source/identity_base.rst b/doc/source/users/identity_base.rst
similarity index 100%
rename from doc/source/identity_base.rst
rename to doc/source/users/identity_base.rst
diff --git a/doc/source/identity_v2.rst b/doc/source/users/identity_v2.rst
similarity index 100%
rename from doc/source/identity_v2.rst
rename to doc/source/users/identity_v2.rst
diff --git a/doc/source/identity_v3.rst b/doc/source/users/identity_v3.rst
similarity index 100%
rename from doc/source/identity_v3.rst
rename to doc/source/users/identity_v3.rst
diff --git a/doc/source/installation.rst b/doc/source/users/installation.rst
similarity index 100%
rename from doc/source/installation.rst
rename to doc/source/users/installation.rst
diff --git a/doc/source/resource.rst b/doc/source/users/resource.rst
similarity index 100%
rename from doc/source/resource.rst
rename to doc/source/users/resource.rst
diff --git a/doc/source/resources/object_store/v1/container.rst b/doc/source/users/resources/object_store/v1/container.rst
similarity index 100%
rename from doc/source/resources/object_store/v1/container.rst
rename to doc/source/users/resources/object_store/v1/container.rst
diff --git a/doc/source/resources/object_store/v1/obj.rst b/doc/source/users/resources/object_store/v1/obj.rst
similarity index 100%
rename from doc/source/resources/object_store/v1/obj.rst
rename to doc/source/users/resources/object_store/v1/obj.rst
diff --git a/doc/source/service_filter.rst b/doc/source/users/service_filter.rst
similarity index 100%
rename from doc/source/service_filter.rst
rename to doc/source/users/service_filter.rst
diff --git a/doc/source/session.rst b/doc/source/users/session.rst
similarity index 100%
rename from doc/source/session.rst
rename to doc/source/users/session.rst
diff --git a/doc/source/transport.rst b/doc/source/users/transport.rst
similarity index 100%
rename from doc/source/transport.rst
rename to doc/source/users/transport.rst
diff --git a/doc/source/usage.rst b/doc/source/users/usage.rst
similarity index 100%
rename from doc/source/usage.rst
rename to doc/source/users/usage.rst
diff --git a/doc/source/user_preference.rst b/doc/source/users/user_preference.rst
similarity index 100%
rename from doc/source/user_preference.rst
rename to doc/source/users/user_preference.rst
diff --git a/doc/source/userguides/object_store.rst b/doc/source/users/userguides/object_store.rst
similarity index 100%
rename from doc/source/userguides/object_store.rst
rename to doc/source/users/userguides/object_store.rst