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

[DOCS] Add codeblock for alt-text to Images for Admin Guide #14497

Closed
5 of 11 tasks
tvo318 opened this issue Oct 2, 2023 · 3 comments
Closed
5 of 11 tasks

[DOCS] Add codeblock for alt-text to Images for Admin Guide #14497

tvo318 opened this issue Oct 2, 2023 · 3 comments
Assignees
Labels

Comments

@tvo318
Copy link
Member

tvo318 commented Oct 2, 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 [email protected] instead.)

Bug Summary

We need to add alt-text to images for accessibility purposes. See the syntax in the Expected Results below.

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

No response

Web browser

No response

Steps to reproduce

  1. Clone the AWX repo.
  2. Navigate to the source files for the User Guide in GitHub at: https://github.com/ansible/awx/tree/devel/docs/docsite/rst/userguide (locally they should reside in /Users/you/awx/docs/docsite/rst/userguide).
  3. Open an .rst file, as applicable, to edit it. Search all image directives and place the :alt: code block beneath it. See syntax in Expected Results below.
  4. Commit the changes, open a PR.

Expected results

The following codeblock added to each image with its specific descriptors filled in:

.. image:: ../common/images/image-filename.png
   :alt: Phrase that describes image

or

|Resource - alt text describing image|

.. |Resource - alt text describing image| image:: ../common/images/image-filename.png
   :alt: Phrase that describes image

Actual results

Some images don't have the alt text info in them.

Additional information

Example from Credentials section of the User Guide:

Add Team Permissions
^^^^^^^^^^^^^^^^^^^^^^

To add permissions to a Team:

1. Click the **Add** button, which opens the Add Permissions Wizard.

.. image:: ../common/images/teams-users-add-permissions-form.png 
   :alt: Add Permissions Form

@krushn-a
Copy link

krushn-a commented Oct 7, 2023

Hi @tvo318 , can I work on this issue?

@krushn-a
Copy link

Hii @tvo318 I was making some changes and i noticed whether i have to make changes in whole administrator folder

Capture

@tvo318
Copy link
Member Author

tvo318 commented Oct 20, 2023

@krushn-a - yes, but you can choose just one or a few chapters, whatever you can do is fine! thanks so much for your interest in helping!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants