Files

Don Naro f0a518baf6 Remove Helm chart code (#1938 )

* rm Helm chart starter directory

* rm Helm release playbook

* rm Helm install from docs

* rm Helm chart workflows

* rm Helm starter from yamllint

* rm Helm targets from Makefile

* Revert "rm Helm targets from Makefile"

This reverts commit da383601683c7fe277fce61a4d62bd0380ff2bd2.

* remove helm from Makefile

* rm kubectl-slice and yp from Makefile

2024-08-08 13:39:33 -04:00

contributors-guide

docs: overall minor renovations (#1874 )

2024-07-20 18:34:21 -04:00

installation

Remove Helm chart code (#1938 )

2024-08-08 13:39:33 -04:00

migration

docs: overall minor renovations (#1874 )

2024-07-20 18:34:21 -04:00

troubleshooting

docs: overall minor renovations (#1874 )

2024-07-20 18:34:21 -04:00

uninstall

docs: overall minor renovations (#1874 )

2024-07-20 18:34:21 -04:00

upgrade

docs: overall minor renovations (#1874 )

2024-07-20 18:34:21 -04:00

user-guide

docs: overall minor renovations (#1874 )

2024-07-20 18:34:21 -04:00

index.md

docs: overall minor renovations (#1874 )

2024-07-20 18:34:21 -04:00

README.md

Format Markdown list properly in upgrading.md (#1825 )

2024-04-17 19:15:03 +00:00

requirements.in

Use pip tools to generate the full dependency tree (#1727 )

2024-02-28 14:33:29 -05:00

requirements.txt

Bump mkdocs-ansible from 24.3.0 to 24.3.1 in /docs in the dependencies group (#1856 )

2024-05-20 15:05:09 -04:00

README.md

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 to http://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.