mirror of
https://github.com/ansible/awx-operator.git
synced 2026-03-26 21:33:14 +00:00
2b0221bbc6
* docs: simplify README.md and make index.md to refer to it * docs: change order for pages in navigation and add missing pages * docs: fix headings to improve navigation, transform notes to admonition, fix indentation, linting issues and minor issues * docs: merge docs for using images from private registries * docs: add example to integrate LDAP configuration via extra_settings_files * Apply suggestions from code review docs: apply suggested changes Co-authored-by: Don Naro <dnaro@redhat.com> * docs: update the doc site url as same as the url in https://www.ansible.com/ecosystem/ * docs: minor fixes for hpa page * docs: expand note block * docs: apply #1904 to README.md --------- Co-authored-by: Don Naro <dnaro@redhat.com>
Building the Ansible AWX Operator Docs
To build the AWX Operator docs locally:
- Clone the AWX operator repository.
- Preferrably, create a virtual environment for installing the dependencies.
a.python3 -m venv venv
b.source venv/bin/activate - From the root directory:
a.pip install -r docs/requirements.txt
b.mkdocs build - View the docs in your browser:
a.mkdocs serve
b. Open your browser and navigate tohttp://127.0.0.1:8000/
This will create a new directory called site/ in the root of your clone containing the index.html and static files.