mirror of
https://github.com/ansible/awx-operator.git
synced 2026-03-26 21:33:14 +00:00
400df47678
- Describe checking out the tag to deploy in basic install instructions - Also, the repo already contains a awx-demo.yml file but the doc reference awx-demo.yaml with en extra a. I remove this road block for newcomers by using same 'yml' extension everywhere.
Building the Ansible AWX Operator Docs
To build the AWX Operator docs locally:
- Clone the AWX operator repository.
- From the root directory: a. pip install --user -r docs/requirements.txt b. mkdocs build
This will create a new directory called site/ in the root of your clone containing the index.html and static files. To view the docs in your browser, navigate there in your file explorer and double-click on the index.html file. This should open the docs site in your browser.