From 8846925640420b45efee10617372255cd188d7ba Mon Sep 17 00:00:00 2001 From: Steve Wilkerson Date: Mon, 3 Jul 2017 11:54:12 -0500 Subject: [PATCH] Documentation reorganization and cleanup This removes empty documentation pages and places the troubleshooting docs to the top of the docs/source tree. Also places the pod disruption budget docs to the rest of the getting-started docs, which are primarily concepts used in openstack-helm Change-Id: Ic3f8deefbd873ae5332e14a12351d9967eb22b1b --- doc/source/devref/dev-helm/helm-toolkit.rst | 3 --- doc/source/devref/dev-helm/index.rst | 11 ----------- doc/source/devref/dev-helm/registration.rst | 18 ------------------ doc/source/devref/dev-helm/tips.rst | 2 -- .../devref/dev-kubernetes/considerations.rst | 3 --- doc/source/devref/dev-kubernetes/index.rst | 9 --------- doc/source/devref/getting-started/index.rst | 1 + .../pod-disruption-budgets.rst} | 0 doc/source/devref/index.rst | 2 -- doc/source/index.rst | 3 +-- doc/source/operator/getting-started.rst | 3 --- doc/source/operator/helm.rst | 9 --------- doc/source/operator/index.rst | 15 --------------- doc/source/operator/network.rst | 9 --------- doc/source/operator/openstack.rst | 11 ----------- doc/source/operator/security.rst | 12 ------------ .../troubleshooting/database.rst | 0 .../troubleshooting/development.rst | 0 .../{operator => }/troubleshooting/index.rst | 0 .../troubleshooting/networking.rst | 0 .../troubleshooting/persistent-storage.rst | 0 21 files changed, 2 insertions(+), 109 deletions(-) delete mode 100644 doc/source/devref/dev-helm/helm-toolkit.rst delete mode 100644 doc/source/devref/dev-helm/index.rst delete mode 100644 doc/source/devref/dev-helm/registration.rst delete mode 100644 doc/source/devref/dev-helm/tips.rst delete mode 100644 doc/source/devref/dev-kubernetes/considerations.rst delete mode 100644 doc/source/devref/dev-kubernetes/index.rst rename doc/source/{operator/kubernetes.rst => devref/getting-started/pod-disruption-budgets.rst} (100%) delete mode 100644 doc/source/operator/getting-started.rst delete mode 100644 doc/source/operator/helm.rst delete mode 100644 doc/source/operator/index.rst delete mode 100644 doc/source/operator/network.rst delete mode 100644 doc/source/operator/openstack.rst delete mode 100644 doc/source/operator/security.rst rename doc/source/{operator => }/troubleshooting/database.rst (100%) rename doc/source/{operator => }/troubleshooting/development.rst (100%) rename doc/source/{operator => }/troubleshooting/index.rst (100%) rename doc/source/{operator => }/troubleshooting/networking.rst (100%) rename doc/source/{operator => }/troubleshooting/persistent-storage.rst (100%) diff --git a/doc/source/devref/dev-helm/helm-toolkit.rst b/doc/source/devref/dev-helm/helm-toolkit.rst deleted file mode 100644 index 75d9919bb9..0000000000 --- a/doc/source/devref/dev-helm/helm-toolkit.rst +++ /dev/null @@ -1,3 +0,0 @@ -============ -Helm-Toolkit -============ diff --git a/doc/source/devref/dev-helm/index.rst b/doc/source/devref/dev-helm/index.rst deleted file mode 100644 index 5b0306841f..0000000000 --- a/doc/source/devref/dev-helm/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -Helm development -================ - -Contents: - -.. toctree:: - :maxdepth: 2 - - helm-toolkit - registration - tips diff --git a/doc/source/devref/dev-helm/registration.rst b/doc/source/devref/dev-helm/registration.rst deleted file mode 100644 index d6064918d2..0000000000 --- a/doc/source/devref/dev-helm/registration.rst +++ /dev/null @@ -1,18 +0,0 @@ -============ -Registration -============ - -User -==== - -Domain -====== - -Host -==== - -Service -======= - -Endpoint -======== diff --git a/doc/source/devref/dev-helm/tips.rst b/doc/source/devref/dev-helm/tips.rst deleted file mode 100644 index cf7c7459b4..0000000000 --- a/doc/source/devref/dev-helm/tips.rst +++ /dev/null @@ -1,2 +0,0 @@ -Tips and Tricks -=============== diff --git a/doc/source/devref/dev-kubernetes/considerations.rst b/doc/source/devref/dev-kubernetes/considerations.rst deleted file mode 100644 index aab5a74272..0000000000 --- a/doc/source/devref/dev-kubernetes/considerations.rst +++ /dev/null @@ -1,3 +0,0 @@ -===================================== -Kubernetes Development Considerations -===================================== diff --git a/doc/source/devref/dev-kubernetes/index.rst b/doc/source/devref/dev-kubernetes/index.rst deleted file mode 100644 index 59e63306ba..0000000000 --- a/doc/source/devref/dev-kubernetes/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -Kubernetes development -====================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - considerations diff --git a/doc/source/devref/getting-started/index.rst b/doc/source/devref/getting-started/index.rst index 1eec34cfff..19f0cfa353 100644 --- a/doc/source/devref/getting-started/index.rst +++ b/doc/source/devref/getting-started/index.rst @@ -8,6 +8,7 @@ Contents: values overrides + pod-disruption-budgets replicas images resources diff --git a/doc/source/operator/kubernetes.rst b/doc/source/devref/getting-started/pod-disruption-budgets.rst similarity index 100% rename from doc/source/operator/kubernetes.rst rename to doc/source/devref/getting-started/pod-disruption-budgets.rst diff --git a/doc/source/devref/index.rst b/doc/source/devref/index.rst index 5e316b6759..fdde8ffc37 100644 --- a/doc/source/devref/index.rst +++ b/doc/source/devref/index.rst @@ -7,5 +7,3 @@ Contents: :maxdepth: 2 getting-started/index - dev-helm/index - dev-kubernetes/index diff --git a/doc/source/index.rst b/doc/source/index.rst index 1bd902a1ba..66feb32907 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,8 +15,8 @@ Contents: philosophy install/index devref/index - operator/index contributing + troubleshooting/index Indices and tables ================== @@ -24,4 +24,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - diff --git a/doc/source/operator/getting-started.rst b/doc/source/operator/getting-started.rst deleted file mode 100644 index 68bf69dc27..0000000000 --- a/doc/source/operator/getting-started.rst +++ /dev/null @@ -1,3 +0,0 @@ -=============== -Getting started -=============== diff --git a/doc/source/operator/helm.rst b/doc/source/operator/helm.rst deleted file mode 100644 index 8ed3267ab1..0000000000 --- a/doc/source/operator/helm.rst +++ /dev/null @@ -1,9 +0,0 @@ -=============== -Helm Operations -=============== - -OpenStack-Helm Operations -========================= - -Addons and Plugins -================== diff --git a/doc/source/operator/index.rst b/doc/source/operator/index.rst deleted file mode 100644 index 834751ab1a..0000000000 --- a/doc/source/operator/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -Operations Guides -================= - -Contents: - -.. toctree:: - :maxdepth: 2 - - getting-started - helm - kubernetes - network - openstack - security - troubleshooting/index diff --git a/doc/source/operator/network.rst b/doc/source/operator/network.rst deleted file mode 100644 index e37e8828b0..0000000000 --- a/doc/source/operator/network.rst +++ /dev/null @@ -1,9 +0,0 @@ -================= -Networking Guides -================= - -Ingress -======= - -Nodeports -========= diff --git a/doc/source/operator/openstack.rst b/doc/source/operator/openstack.rst deleted file mode 100644 index 8c18e62e9a..0000000000 --- a/doc/source/operator/openstack.rst +++ /dev/null @@ -1,11 +0,0 @@ -==================== -OpenStack Operations -==================== - -OpenStack-Helm Configuration Management -======================================= - -Configuration overrides ------------------------ - -.. include:: ../../../tools/gen-oslo-openstack-helm/README.rst diff --git a/doc/source/operator/security.rst b/doc/source/operator/security.rst deleted file mode 100644 index 3562f45323..0000000000 --- a/doc/source/operator/security.rst +++ /dev/null @@ -1,12 +0,0 @@ -=============== -Security Guides -=============== - -Using namespaces -================ - -SELinux and SECCOMP -=================== - -Role-Based Access Control -========================= diff --git a/doc/source/operator/troubleshooting/database.rst b/doc/source/troubleshooting/database.rst similarity index 100% rename from doc/source/operator/troubleshooting/database.rst rename to doc/source/troubleshooting/database.rst diff --git a/doc/source/operator/troubleshooting/development.rst b/doc/source/troubleshooting/development.rst similarity index 100% rename from doc/source/operator/troubleshooting/development.rst rename to doc/source/troubleshooting/development.rst diff --git a/doc/source/operator/troubleshooting/index.rst b/doc/source/troubleshooting/index.rst similarity index 100% rename from doc/source/operator/troubleshooting/index.rst rename to doc/source/troubleshooting/index.rst diff --git a/doc/source/operator/troubleshooting/networking.rst b/doc/source/troubleshooting/networking.rst similarity index 100% rename from doc/source/operator/troubleshooting/networking.rst rename to doc/source/troubleshooting/networking.rst diff --git a/doc/source/operator/troubleshooting/persistent-storage.rst b/doc/source/troubleshooting/persistent-storage.rst similarity index 100% rename from doc/source/operator/troubleshooting/persistent-storage.rst rename to doc/source/troubleshooting/persistent-storage.rst