internet/awx-operator
3
0
Fork 0
mirror of https://github.com/ansible/awx-operator.git synced 2026-03-26 21:33:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
6e47dc62c29d22cb594d1bfe6525816dc6cd270d
awx-operator/docs
History
Christian Adams 2e9615aa1e Add configurable pull secret file support to up.sh (#2073) 
- Applies a pull-secret yaml file if it exists at hacking/awx-cr.yml
- The operator will look for a pull secret called
  redhat-operators-pull-secret
- This makes it possible to use a private operator image on your quay.io
  registry out of the box with the up.sh
- Add PULL_SECRET_FILE environment variable with default hacking/pull-secret.yml
2025-08-19 11:50:19 -04:00
..
contributors-guide
Docs: update communication section (#1945)
2024-09-05 09:11:13 +01:00
installation
Remove Helm chart code (#1938)
2024-08-08 13:39:33 -04:00
migration
Add ability to exclude postgres data during migration to Openshift AAP operator (#1954)
2024-09-20 03:23:39 +00: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
Parameterization of the client_max_body_size directive in Nginx (#2014)
2025-02-24 12:50:08 -05:00
development.md
Add configurable pull secret file support to up.sh (#2073)
2025-08-19 11:50:19 -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:

  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.