Add Table of Contents for nested doc files

ansible · Aug 2, 2023 · 82f157c · 82f157c
1 parent 7953d42
commit 82f157c
Show file tree

Hide file tree

Showing 6 changed files with 59 additions and 217 deletions.
diff --git a/README.md b/README.md
@@ -12,25 +12,76 @@ An [Ansible AWX](https://github.com/ansible/awx) operator for Kubernetes built w
 <!-- gh-md-toc --insert README.md -->
 <!--ts-->
 
-NOTE:  we are in the process of moving this readme into official docs in the /docs folder. Please go there to find additional sections during this interim move phase.
+**Note**: We are in the process of moving this readme into official docs in the /docs folder. Please go there to find additional sections during this interim move phase.
 
 
 Table of Contents
 =================
 
-* [AWX Operator](#awx-operator)
-   * [Contributing](#contributing)
-   * [Release Process](#release-process)
-   * [Author](#author)
-   * [Code of Conduct](#code-of-conduct)
-   * [Get Involved](#get-involved)
+- [AWX Operator](#awx-operator)
+- [Table of Contents](#table-of-contents)
+  - [Install and Configuration](#install-and-configuration)
+  - [Contributing](#contributing)
+  - [Release Process](#release-process)
+  - [Author](#author)
+  - [Code of Conduct](#code-of-conduct)
+  - [Get Involved](#get-involved)
 
 <!-- Created by https://github.com/ekalinin/github-markdown-toc -->
 
 <!--te-->
 
 
 
+## Install and Configuration
+
+All of our usage and configuration docs are nested in the `docs/` directory. Below is a Table of Contents for those.
+
+- Introduction
+  - [Introduction](./docs/introduction/introduction.md)
+- Contributors Guide
+  - [Code of Conduct](./docs/contributors-guide/code-of-conduct.md)
+  - [Get Involved](./docs/contributors-guide/get-involved.md)
+  - [Contributing](./docs/contributors-guide/contributing.md)
+  - [Release Process](./docs/contributors-guide/release-process.md)
+  - [Authors](./docs/contributors-guide/author.md)
+- Installation
+  - [Basic Install](./docs/installation/basic-install.md)
+  - [Creating a Minikube cluster for testing](./docs/creating-a-minikube-cluster-for-testing.md)
+  - [Installation](./docs/installation/installation.md)
+  - [Helm Install](./docs/installation/helm-install-on-existing-cluster.md)
+- [Migration](./docs/migration/migration.md)
+- [Uninstall](./docs/uninstall/uninstall.md)
+- User Guide
+  - [Admin User Configuration](./docs/user-guide/admin-user-account-configuration.md)
+  - [Database Configuration](./docs/user-guide/database-configuration.md)
+  - [Network and TLS Configuration](./docs/user-guide/network-and-tls-configuration.md)
+  - Advanced Configuration
+    - [No Log](./docs/no-log.md)
+    - [Deploy a Specific Version of AWX](./docs/user-guide/advanced-configuration/deploying-a-specific-version-of-awx.md)
+    - [Resource Requirements](./docs/user-guide/advanced-configuration/containers-resource-requirements.md)
+    - [Extra Settings](./docs/user-guide/advanced-configuration/extra-settings.md)
+    - [Environment Variables](./docs/user-guide/advanced-configuration/exporting-environment-variables-to-containers.md)
+    - [Custom Labels](./docs/user-guide/advanced-configuration/labeling-operator-managed-objects.md)
+    - [Custom Volumes](./docs/user-guide/advanced-configuration/custom-volume-and-volume-mount-options.md)
+    - [Scaling Deployments](./docs/user-guide/advanced-configuration/scaling-the-web-and-task-pods-independently.md)
+    - [Auto Update Upon Operator Upgrade](./docs/user-guide/advanced-configuration/auto-upgrade.md)
+    - [Termination Grace Period](./docs/user-guide/advanced-configuration/pods-termination-grace-period.md)
+    - [Node Selector for Deployments](./docs/user-guide/advanced-configuration/assigning-awx-pods-to-specific-nodes.md)
+    - [Default EE from Private Registries](./docs/user-guide/advanced-configuration/default-execution-environments-from-private-registries.md)
+    - [CSRF Cookie Secure](./docs/user-guide/advanced-configuration/csrf-cookie-secure-setting.md)
+    - [Disable IPv6](./docs/user-guide/advanced-configuration/disable-ipv6.md)
+    - [LDAP](./docs/user-guide/advanced-configuration/enabling-ldap-integration-at-awx-bootstrap.md)
+    - [Priority Clases](./docs/user-guide/advanced-configuration/priority-classes.md)
+    - [Priveleged Tasks](./docs/user-guide/advanced-configuration/privileged-tasks.md)
+    - [Redis Container Capabilities](./docs/user-guide/advanced-configuration/redis-container-capabilities.md)
+    - [Trusting a Custom Certificate Authority](./docs/user-guide/advanced-configuration/trusting-a-custom-certificate-authority.md)
+    - [Service Account](./docs/user-guide/advanced-configuration/service-account.md)
+    - [Persisting the Projects Directory](./docs/user-guide/advanced-configuration/persisting-projects-directory.md)
+- Troubleshooting
+  - [General Debugging](./docs/troubleshooting/debugging.md)
+
+
 ## Contributing
 
 Please visit [our contributing guidelines](https://github.com/ansible/awx-operator/blob/devel/CONTRIBUTING.md).

diff --git a/docs/migration.md → docs/migration/migration.md b/docs/migration.md → docs/migration/migration.md
diff --git a/docs/debugging.md → docs/troubleshooting/debugging.md b/docs/debugging.md → docs/troubleshooting/debugging.md
diff --git a/docs/user-guide/advanced-configuration/debugging.md b/docs/user-guide/advanced-configuration/debugging.md
diff --git a/docs/user-guide/advanced-configuration/migration.md b/docs/user-guide/advanced-configuration/migration.md
diff --git a/docs/user-guide/database-configuration.md b/docs/user-guide/database-configuration.md
@@ -48,7 +48,7 @@ spec:
 
 #### Migrating data from an old AWX instance
 
-For instructions on how to migrate from an older version of AWX, see [migration.md](/docs/user-guide/advanced-configuration/migration.md).
+For instructions on how to migrate from an older version of AWX, see [migration.md](/docs/migration/migration.md).
 
 #### Managed PostgreSQL Service