mirror of
https://github.com/ansible/awx-operator.git
synced 2026-03-26 21:33:14 +00:00
2b0221bbc6
* docs: simplify README.md and make index.md to refer to it * docs: change order for pages in navigation and add missing pages * docs: fix headings to improve navigation, transform notes to admonition, fix indentation, linting issues and minor issues * docs: merge docs for using images from private registries * docs: add example to integrate LDAP configuration via extra_settings_files * Apply suggestions from code review docs: apply suggested changes Co-authored-by: Don Naro <dnaro@redhat.com> * docs: update the doc site url as same as the url in https://www.ansible.com/ecosystem/ * docs: minor fixes for hpa page * docs: expand note block * docs: apply #1904 to README.md --------- Co-authored-by: Don Naro <dnaro@redhat.com>
139 lines
4.8 KiB
YAML
139 lines
4.8 KiB
YAML
---
|
|
site_name: Ansible AWX Operator Documentation
|
|
site_url: https://awx-operator.readthedocs.io/
|
|
repo_url: https://github.com/ansible/awx-operator
|
|
edit_uri: blob/devel/docs/
|
|
docs_dir: docs
|
|
strict: true
|
|
use_directory_urls: false
|
|
|
|
theme:
|
|
name: "ansible"
|
|
features:
|
|
- content.code.copy
|
|
- content.action.edit
|
|
- navigation.expand
|
|
- navigation.sections
|
|
- navigation.instant
|
|
- navigation.indexes
|
|
- navigation.tracking
|
|
- toc.integrate
|
|
- search.highlight
|
|
- search.share
|
|
- search.suggest
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
primary: teal
|
|
accent: blue
|
|
scheme: default
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: teal
|
|
accent: blue
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Installation:
|
|
- installation/basic-install.md
|
|
- installation/helm-install-on-existing-cluster.md
|
|
- installation/kind-install.md
|
|
- installation/creating-a-minikube-cluster-for-testing.md
|
|
- Migrate:
|
|
- migration/migration.md
|
|
- Upgrade:
|
|
- upgrade/upgrading.md
|
|
- Uninstall:
|
|
- uninstall/uninstall.md
|
|
- User Guide:
|
|
- user-guide/admin-user-account-configuration.md
|
|
- user-guide/network-and-tls-configuration.md
|
|
- user-guide/database-configuration.md
|
|
- Advanced Configuration:
|
|
- user-guide/advanced-configuration/deploying-a-specific-version-of-awx.md
|
|
- user-guide/advanced-configuration/redis-container-capabilities.md
|
|
- user-guide/advanced-configuration/privileged-tasks.md
|
|
- user-guide/advanced-configuration/host-aliases.md
|
|
- user-guide/advanced-configuration/containers-resource-requirements.md
|
|
- user-guide/advanced-configuration/priority-classes.md
|
|
- user-guide/advanced-configuration/scaling-the-web-and-task-pods-independently.md
|
|
- user-guide/advanced-configuration/horizontal-pod-autoscaler.md
|
|
- user-guide/advanced-configuration/assigning-awx-pods-to-specific-nodes.md
|
|
- user-guide/advanced-configuration/trusting-a-custom-certificate-authority.md
|
|
- user-guide/advanced-configuration/custom-receptor-certs.md
|
|
- user-guide/advanced-configuration/enabling-ldap-integration-at-awx-bootstrap.md
|
|
- user-guide/advanced-configuration/persisting-projects-directory.md
|
|
- user-guide/advanced-configuration/custom-volume-and-volume-mount-options.md
|
|
- user-guide/advanced-configuration/exporting-environment-variables-to-containers.md
|
|
- user-guide/advanced-configuration/csrf-cookie-secure-setting.md
|
|
- user-guide/advanced-configuration/session-cookie-secure-setting.md
|
|
- user-guide/advanced-configuration/extra-settings.md
|
|
- user-guide/advanced-configuration/no-log.md
|
|
- user-guide/advanced-configuration/auto-upgrade.md
|
|
- user-guide/advanced-configuration/service-account.md
|
|
- user-guide/advanced-configuration/labeling-operator-managed-objects.md
|
|
- user-guide/advanced-configuration/pods-termination-grace-period.md
|
|
- user-guide/advanced-configuration/security-context.md
|
|
- user-guide/advanced-configuration/container-probes.md
|
|
- user-guide/advanced-configuration/disable-ipv6.md
|
|
- user-guide/advanced-configuration/mesh-ingress.md
|
|
- Troubleshooting:
|
|
- troubleshooting/debugging.md
|
|
- Contributors Guide:
|
|
- contributors-guide/contributing.md
|
|
- contributors-guide/release-process.md
|
|
- contributors-guide/author.md
|
|
- contributors-guide/code-of-conduct.md
|
|
- contributors-guide/get-involved.md
|
|
|
|
exclude_docs:
|
|
README.md
|
|
|
|
plugins:
|
|
- autorefs
|
|
- markdown-exec
|
|
- material/search:
|
|
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
paths: [src]
|
|
options:
|
|
# Sphinx is for historical reasons, but we could consider switching if needed
|
|
# https://mkdocstrings.github.io/griffe/docstrings/
|
|
docstring_style: sphinx
|
|
merge_init_into_class: yes
|
|
show_submodules: yes
|
|
import:
|
|
- url: https://docs.ansible.com/ansible/latest/objects.inv
|
|
domains: [py, std]
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- def_list
|
|
- footnotes
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets:
|
|
check_paths: true
|
|
- pymdownx.superfences
|
|
- pymdownx.magiclink:
|
|
repo_url_shortener: true
|
|
repo_url_shorthand: true
|
|
social_url_shorthand: true
|
|
social_url_shortener: true
|
|
user: facelessuser
|
|
repo: pymdown-extensions
|
|
normalize_issue_symbols: true
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- toc:
|
|
toc_depth: 2
|
|
permalink: true
|