Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: broken reference to API url #14699 #14992

Merged
merged 1 commit into from
Mar 27, 2024

Conversation

PabloHiro
Copy link
Contributor

@PabloHiro PabloHiro commented Mar 14, 2024

SUMMARY

Fixing the following issue:
#14699

image

The link currently points to:
https://docs.ansible.com/ansible-tower/23.9.0/html/towerapi/index.html

Instead of:
https://ansible.readthedocs.io/projects/awx/en/latest/rest_api/api_ref.html

As a compromise, I think it is best to make it point here:
https://docs.ansible.com/automation-controller/latest/html/towerapi/

ISSUE TYPE
  • Bug, Docs Fix or other nominal change
COMPONENT NAME
  • Docs
AWX VERSION

All

ADDITIONAL INFORMATION

@tvo318
Copy link
Member

tvo318 commented Mar 15, 2024

@PabloHiro - Thanks for working on this! I'm afraid we are sunsetting https://docs.ansible.com/automation-controller/ and https://docs.ansible.com/ansible-tower as all the upstream docs have migrated to https://ansible.readthedocs.io/projects/awx/en/latest/ and dowstream docs migrated to https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4. So, we'll need to point everything in the UI and API to readthedocs. Also, this PR will need to also address the UI Help button in issue ##14699 before we can resolve it completely.

tvo318
tvo318 previously requested changes Mar 15, 2024
awx/templates/rest_framework/api.html Outdated Show resolved Hide resolved
@tvo318 tvo318 requested a review from fosterseth March 15, 2024 15:31
Copy link
Member

@fosterseth fosterseth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just need to change the link to upstream docs, thanks for updating this

@PabloHiro PabloHiro force-pushed the fix/api-reference-url branch 3 times, most recently from 4b1f886 to a64493f Compare March 20, 2024 10:35
@PabloHiro PabloHiro enabled auto-merge (rebase) March 20, 2024 15:55
@PabloHiro PabloHiro requested review from fosterseth, tvo318 and mabashian and removed request for mabashian March 20, 2024 15:59
@chrismeyersfsu chrismeyersfsu dismissed stale reviews from fosterseth and tvo318 March 27, 2024 19:37

talked in person, he is ok with the state of this pr

@PabloHiro PabloHiro merged commit d9b8173 into ansible:devel Mar 27, 2024
21 checks passed
@PabloHiro PabloHiro deleted the fix/api-reference-url branch April 1, 2024 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants