Files
awx-operator/docs
Chi Cuong HA cdab3dd538 fix: Make basic install without operator works (#1875)
- Update role name for README.md
  - Avoid the this_awx['resources'][0] is undefined in database_configuration.yml
  - Add update_status variable to include or not the update_status.yml
  - metrics_utility_enabled exists in CRD but not as variable

Co-authored-by: Christian Adams <chadams@redhat.com>
2024-07-03 19:12:47 +00:00
..
2024-06-26 20:17:22 +00:00
2023-08-03 15:13:11 -04:00

Building the Ansible AWX Operator Docs

To build the AWX Operator docs locally:

  1. Clone the AWX operator repository.
  2. Preferrably, create a virtual environment for installing the dependencies.
    a. python3 -m venv venv
    b. source venv/bin/activate
  3. From the root directory:
    a. pip install -r docs/requirements.txt
    b. mkdocs build
  4. 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.