awx-operator/docs/doc-proposal.md

Docs Breakdown for AWX Operator

Introduction

This table below is aimed at breaking down the ReadME documentation for Ansible AWX Operator and structure it in the way it can be moved to the Read The Docs module.

From the ReadMe file, the documentation can be classified into six distinct segments which are:

• Introduction/Getting Started
• Installation
• User Guide
• Upgrade
• Uninstall
• Contributors Guide

Using these listed segments, we can do a proper breakdown of all the topics in the ReadMe and place each one in the segment they fall into. This table is open to any form of refactoring or modifications.

Segments	Topics
Introduction	- Purpose
Installation	- Creating a minikube cluster for testing - Basic Install - Helm Install on existing cluster
User Guide	- Admin user account configuration - Network and TLS Configuration * Service Type * Ingress Type - Database Configuration * External PostgreSQL Service * Migrating data from an old AWX instance * Managed PostgreSQL Service - Advanced Configuration * Deploying a specific version of AWX * Redis container capabilities * Privileged Tasks * Containers Resource Requirements * Priority Classes * Assigning AWX pods to specific nodes * Trusting a Custom Certificate Authority * Enabling LDAP Integration at AWX bootstrap * Persisting Projects Directory * Custom Volume and Volume Mount Options * Default execution environments from private registries * * Control plane ee from private registry * Exporting Environment Variables to Containers * CSRF Cookie Secure Setting * Session Cookie Secure Setting * Extra Settings * Configure no_log * Auto Upgrade ** Upgrade of instances without auto upgrade * Service Account * Labeling operator managed objects * Pods termination grace period * Disable IPV6 * Add Execution Nodes ** Custom Receptor CA * Debugging * Migration
Upgrade	- Upgrading * Backup * v0.14.0 ** Cluster-scope to Namespace-scope considerations ** Project is now based on v1.x of the operator-sdk project ** Steps to upgrade
Uninstall	- Uninstall
Contributors Guide	- Contributing - Release Process - Author - Code of Conduct - Get Involved

Note: I could not get the multi-level bullet point list to work in the table so I used single asterisk * for one level down and double asterisk ** for two level down.