diff options
author | TVo <thavo@redhat.com> | 2024-07-24 15:54:43 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-07-24 15:54:43 +0200 |
commit | 018f235a645163ee820ff33b47a70194fabeea66 (patch) | |
tree | 0450ef77ce9d0c0ecc3a3f2a67dfdc26ca710500 /awx_collection | |
parent | Add UI for RECEPTOR_KEEP_WORK_ON_ERROR (diff) | |
download | awx-018f235a645163ee820ff33b47a70194fabeea66.tar.xz awx-018f235a645163ee820ff33b47a70194fabeea66.zip |
Replaced all references of downstream docs to upstream docs (#15388)
* Replaced all references of downstream docs to upstream docs.
* Update README.md
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update README.md.j2
Co-authored-by: Don Naro <dnaro@redhat.com>
* Update README.md.j2
Co-authored-by: Don Naro <dnaro@redhat.com>
* Incorpor'd review feedback from @oraNod and @samccann
* Updated with agreed link (for now) until further change is needed.
---------
Co-authored-by: Don Naro <dnaro@redhat.com>
Diffstat (limited to 'awx_collection')
-rw-r--r-- | awx_collection/README.md | 5 | ||||
-rw-r--r-- | awx_collection/plugins/lookup/controller_api.py | 2 | ||||
-rw-r--r-- | awx_collection/plugins/modules/job_template.py | 8 | ||||
-rw-r--r-- | awx_collection/tools/roles/template_galaxy/templates/README.md.j2 | 5 |
4 files changed, 9 insertions, 11 deletions
diff --git a/awx_collection/README.md b/awx_collection/README.md index c3b6f9d529..b6dd3f3a8d 100644 --- a/awx_collection/README.md +++ b/awx_collection/README.md @@ -32,7 +32,7 @@ Installing the `tar.gz` involves no special instructions. ## Running Non-deprecated modules in this collection have no Python requirements, but -may require the official [AWX CLI](https://docs.ansible.com/ansible-tower/latest/html/towercli/index.html) +may require the official [AWX CLI](https://pypi.org/project/awxkit/) in the future. The `DOCUMENTATION` for each module will report this. You can specify authentication by a combination of either: @@ -41,8 +41,7 @@ You can specify authentication by a combination of either: - host, OAuth2 token The OAuth2 token is the preferred method. You can obtain a token via the -AWX CLI [login](https://docs.ansible.com/ansible-tower/latest/html/towercli/reference.html#awx-login) -command. +``login`` command with the AWX CLI. These can be specified via (from highest to lowest precedence): diff --git a/awx_collection/plugins/lookup/controller_api.py b/awx_collection/plugins/lookup/controller_api.py index 6f0d07a4d7..4d5d79cf91 100644 --- a/awx_collection/plugins/lookup/controller_api.py +++ b/awx_collection/plugins/lookup/controller_api.py @@ -12,7 +12,7 @@ requirements: - None description: - Returns GET requests from the Automation Platform Controller API. See - U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/index.html) for API usage. + U(https://docs.ansible.com/automation-controller/latest/html/towerapi/) for API usage. - For use that is cross-compatible between the awx.awx and ansible.controller collection see the controller_meta module options: diff --git a/awx_collection/plugins/modules/job_template.py b/awx_collection/plugins/modules/job_template.py index 81fe495120..6f09e2a5aa 100644 --- a/awx_collection/plugins/modules/job_template.py +++ b/awx_collection/plugins/modules/job_template.py @@ -16,9 +16,9 @@ DOCUMENTATION = ''' --- module: job_template author: "Wayne Witzel III (@wwitzel3)" -short_description: create, update, or destroy Automation Platform Controller job templates. +short_description: create, update, or destroy job templates. description: - - Create, update, or destroy Automation Platform Controller job templates. See + - Create, update, or destroy job templates. See U(https://www.ansible.com/tower) for an overview. options: name: @@ -320,8 +320,8 @@ extends_documentation_fragment: awx.awx.auth notes: - JSON for survey_spec can be found in the API Documentation. See - U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/api_ref.html#/Job_Templates/Job_Templates_job_templates_survey_spec_create) - for POST operation payload example. + U(https://docs.ansible.com/automation-controller/latest/html/towerapi) + for job template survey creation and POST operation payload example. ''' diff --git a/awx_collection/tools/roles/template_galaxy/templates/README.md.j2 b/awx_collection/tools/roles/template_galaxy/templates/README.md.j2 index 94c42b701a..c80b7fc397 100644 --- a/awx_collection/tools/roles/template_galaxy/templates/README.md.j2 +++ b/awx_collection/tools/roles/template_galaxy/templates/README.md.j2 @@ -37,7 +37,7 @@ This collection should be installed from [Content Hub](https://cloud.redhat.com/ ## Running Non-deprecated modules in this collection have no Python requirements, but -may require the official [AWX CLI](https://docs.ansible.com/ansible-tower/latest/html/towercli/index.html) +may require the AWX CLI in the future. The `DOCUMENTATION` for each module will report this. You can specify authentication by a combination of either: @@ -46,8 +46,7 @@ You can specify authentication by a combination of either: - host, OAuth2 token The OAuth2 token is the preferred method. You can obtain a token via the -AWX CLI [login](https://docs.ansible.com/ansible-tower/latest/html/towercli/reference.html#awx-login) -command. +``login`` command with the AWX CLI. These can be specified via (from highest to lowest precedence): |