mirror of
https://github.com/ansible/awx-operator.git
synced 2026-04-14 21:01:17 +00:00
9c3f521514
* Add standardized Makefile includes and developer documentation Introduce modular Makefile system (common.mk + operator.mk) for consistent dev workflows. Standardize CONTRIBUTING.md and docs/development.md to follow community conventions with clear separation: contributing guidelines for process, development guide for technical setup. - Add common.mk with shared dev workflow targets (make up/down) - Add operator.mk with AWX-specific variables and targets - Restructure CONTRIBUTING.md: process, testing requirements, community links - Expand docs/development.md: customization options table, teardown options, Molecule testing, bundle generation via make targets - Simplify README.md contributing section Assisted-by: Claude Signed-off-by: Lucas Benedito <lbenedit@redhat.com> * Fix DEV_IMG docs example to avoid double-tag issue Assisted-by: Claude Signed-off-by: Lucas Benedito <lbenedit@redhat.com> --------- Signed-off-by: Lucas Benedito <lbenedit@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.