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

Link to docs in UI's Help Button needs to go to the AWX docs #14699

Closed
6 of 11 tasks
tvo318 opened this issue Dec 4, 2023 · 4 comments
Closed
6 of 11 tasks

Link to docs in UI's Help Button needs to go to the AWX docs #14699

tvo318 opened this issue Dec 4, 2023 · 4 comments

Comments

@tvo318
Copy link
Member

tvo318 commented Dec 4, 2023

Please confirm the following

  • I agree to follow this project's code of conduct.
  • I have checked the current issues for duplicates.
  • I understand that AWX is open source software provided for free and that I might not receive a timely response.
  • I am NOT reporting a (potential) security vulnerability. (These should be emailed to security@ansible.com instead.)

Bug Summary

The Help button link on the AWX UI currently goes to the controller docs. It needs to be re-addressed to the new AWX docs URL instead: https://ansible.readthedocs.io/projects/awx/en/latest/userguide/index.html

AWX version

latest

Select the relevant components

  • UI
  • UI (tech preview)
  • API
  • Docs
  • Collection
  • CLI
  • Other

Installation method

kubernetes

Modifications

no

Ansible version

No response

Operating system

MacOS

Web browser

Chrome

Steps to reproduce

  1. Run an instance of AWX and log in with your credentials.
  2. At the top of the screen, click (?) drop-down menu and select Help.
  3. The controller docs open.

Expected results

Help needs to go to: https://ansible.readthedocs.io/projects/awx/en/latest/userguide/index.html

Actual results

Help goes to: https://docs.ansible.com/automation-controller/latest/html/userguide/index.html

Additional information

Location of the Help button:
image

@airtonbjunior
Copy link

Hi, @tvo318! I would like to add some details about the issue

The AWX documentation page does not have a version selector, it always redirects to the latest version (and to the english version). It's important that it also works when the documentation page is versioned in the future, similar to the ansible doc.

image

image

The funcion getDocsBaseUrl in getDocsBaseUrl.js return the base url to the documentation page. Specifically about the help button, the function is used in the file PageHeaderToolbar.js, line 113:

href={${getDocsBaseUrl(config)}/html/userguide/index.html}

One possible solution is create a new function (or change the getDocsBaseUrl¹) to return the new baseUrl and keep the conditional, returning
https://ansible.readthedocs.io/projects/awx/en/${version}
instead of
https://docs.ansible.com/automation-controller/${version}

It might be interesting to also create another variable to control the documentation language for future updates, returning something like
https://ansible.readthedocs.io/projects/awx/${language}/${version}

¹It is important to consider that this function is called on 32 different files to provide links to the ansible documentation.

@tvo318
Copy link
Member Author

tvo318 commented Dec 5, 2023

@airtonbjunior, we decided to only support latest. Let's move your suggestion to the Forum and see whether we can get some discussion going and feedback on this topic.

@kurokobo
Copy link
Contributor

@tvo318
Hi, I found the HELP button on the API page is not working as well.
Currently this is the link for https://docs.ansible.com/ansible-tower/23.8.1/html/towerapi/index.html which is 404.

image

@kurokobo
Copy link
Contributor

This is completely out-of-topic but the copyright at the bottom of the page above is still in 2021, should it be released year of the version?

PabloHiro added a commit to PabloHiro/awx that referenced this issue Mar 14, 2024

Verified

This commit was signed with the committer’s verified signature.
scala-steward Scala Steward
PabloHiro added a commit to PabloHiro/awx that referenced this issue Mar 14, 2024
PabloHiro added a commit to PabloHiro/awx that referenced this issue Mar 14, 2024
PabloHiro added a commit to PabloHiro/awx that referenced this issue Mar 14, 2024
PabloHiro added a commit to PabloHiro/awx that referenced this issue Mar 15, 2024
@tvo318 tvo318 closed this as completed Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants