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.

Sign up for GitHub

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

Jump to bottom

[WIP] Sprint: Add/update alt-text for images #222

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[WIP] Sprint: Add/update alt-text for images #222

wants to merge 1 commit into from

Conversation

pavithraes
Copy link
Member

@pavithraes pavithraes commented Nov 14, 2022 •
edited
Loading

We'll have a sprint so that the team can contribute to this PR!

Right now, we have tagged the lines where we need to add/update the alt-text.

If you are participating in the sprint, use the GitHub code-review option to "suggest" updates. Make sure to first leave a comment to let folks know that you're working on a particular line. :)

Useful link:

All images are located in:

Reference Issues or PRs

Fixes #104

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features to not work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

@netlify
Copy link

netlify bot commented Nov 14, 2022 •
edited
Loading

✅ Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit 2482de1
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/6372489f04777a00094d423f
😎 Deploy Preview https://deploy-preview-222--nebari-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@pavithraes pavithraes changed the title [WIP] Add/update alt-text for images [WIP] Sprint: Add/update alt-text for images Nov 14, 2022
@pavithraes pavithraes added type: enhancement 💅🏼 New feature or request area: documentation 📖 area: accessibility ♿️ Accessibility related features or issues DO-NOT-MERGE This is not ready for merge labels Nov 14, 2022
@trallard trallard self-assigned this Nov 14, 2022
pavithraes
pavithraes commented Nov 14, 2022
View reviewed changes
docs/docs/get-started/cloud-providers.mdx
@@ -28,7 +28,7 @@ import TabItem from '@theme/TabItem';
<TabItem value="gcp" label="Google GCP" default>

<div class="text--center">
<img src="/img/get-started/started-google-cloud-logo.png" width={420} />
<img src="/img/get-started/started-google-cloud-logo.png" alt="" width={420} />
Copy link
Member Author

Choose a reason for hiding this comment

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

I'm working on this

Copy link
Member Author

@pavithraes pavithraes Nov 14, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
<img src="/img/get-started/started-google-cloud-logo.png" alt="" width={420} />
<img src="/img/get-started/started-google-cloud-logo.png" alt="" width={420} />

Copy link
Member Author

Choose a reason for hiding this comment

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

(As mentioned on call) We don't need this one because it's redundant.

gabalafou
gabalafou reviewed Nov 14, 2022
View reviewed changes
docs/docs/troubleshooting.mdx
@@ -26,7 +26,7 @@ This is a manual process that consists in copying over the yaml specifications f

Once all environments are migrated, you will be able to delete the `default` and `filesystem` namespaces using the `delete` option from the conda-store UI:

![delete-namespace](/img/troubleshooting/delete_namespace.png)
![delete-namespace ](/img/troubleshooting/delete_namespace.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'll work on this

Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like this image simply repeats what's covered in the preceding paragraph, so I think it would be best to set the alt text to empty:

Suggested change
![delete-namespace ](/img/troubleshooting/delete_namespace.png)
![](/img/troubleshooting/delete_namespace.png)

I made a slight modification to the preceding paragraph so that it talks about the delete "button" rather than delete "option" because "option" makes me think of a dropdown or a menu of possible options or actions, which is not what the UI depicted in the screenshot shows.

pavithraes
pavithraes commented Nov 14, 2022
View reviewed changes
docs/docs/tutorials/creating-cds-dashboard.md
@@ -74,7 +74,7 @@ In this section, you'll use CDS Dashboards to publish and share your newly creat

To begin, click on the top left tab navigate to `File` -> `Hub Control Panel` -> `Dashboards`. Click on the button `New Dashboard`. You will now be presented with a new window where you'll need to provide additional details for your dashboard (see image below for reference).

![CDS dashboard configuration screenshot](/img/tutorials/window_dashboard_configuration_example.png)
![CDS dashboard configuration screenshot ](/img/tutorials/window_dashboard_configuration_example.png)
Copy link
Member Author

Choose a reason for hiding this comment

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

Working on this

gabalafou
gabalafou reviewed Nov 14, 2022
View reviewed changes
docs/docs/troubleshooting.mdx
@@ -26,7 +26,7 @@ This is a manual process that consists in copying over the yaml specifications f

Once all environments are migrated, you will be able to delete the `default` and `filesystem` namespaces using the `delete` option from the conda-store UI:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Once all environments are migrated, you will be able to delete the `default` and `filesystem` namespaces using the `delete` option from the conda-store UI:
Once all environments are migrated, you will be able to delete the `default` and `filesystem` namespaces by clicking on their respective delete buttons in the conda-store UI:

gabalafou
gabalafou reviewed Nov 14, 2022
View reviewed changes
docs/docs/how-tos/using-vscode.md
Comment on lines 15 to 16
Next, bring up the `New Launcher` window by clicking the `+` in the top left of
the screen. Now click on the VS Code logo on the Launcher window.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Next, bring up the `New Launcher` window by clicking the `+` in the top left of
the screen. Now click on the VS Code logo on the Launcher window.
Next, bring up the `New Launcher` window by clicking the `+` in the top left of
the screen. Now click on the VS Code logo inside the Launcher window.

gabalafou
gabalafou reviewed Nov 14, 2022
View reviewed changes
docs/docs/how-tos/using-vscode.md
@@ -15,15 +15,15 @@ to Nebari and spin up a JupyterLab instance.
Next, bring up the `New Launcher` window by clicking the `+` in the top left of
the screen. Now click on the VS Code logo on the Launcher window.

![JupyterLab Launcher window with VS Code](/img/tutorials/vscode_launcher.png)
![JupyterLab Launcher window with VS Code ](/img/tutorials/vscode_launcher.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
![JupyterLab Launcher window with VS Code ](/img/tutorials/vscode_launcher.png)
![](/img/tutorials/vscode_launcher.png)

gabalafou
gabalafou reviewed Nov 14, 2022
View reviewed changes
docs/docs/how-tos/using-vscode.md

You will now have been redirected to a new web browser page showing the VS
Code platform. If you're starting VS Code for the first time, you'll see a
Welcome Page with some helpful links and tips.

Feel free to explore!

![VS Code Welcome screen](/img/tutorials/vscode_welcome.png)
![VS Code Welcome screen ](/img/tutorials/vscode_welcome.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
![VS Code Welcome screen ](/img/tutorials/vscode_welcome.png)
![VS Code Welcome screen](/img/tutorials/vscode_welcome.png)

trallard
trallard reviewed Nov 14, 2022
View reviewed changes
docs/docs/get-started/installing-nebari.md
@@ -75,7 +75,7 @@ You can pass the `--help` flag to the `init` command to check all the arguments
nebari init --help
```

![A representation of the output generated when Nebari init help command is executed, the output contains a list of the available options and arguments and their use.](/img/get-started/nebari-init-help-2.png "Nebari's init help command line output")
![A representation of the output generated when Nebari init help command is executed, the output contains a list of the available options and arguments and their use. ](/img/get-started/nebari-init-help-2.png "Nebari's init help command line output")
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
![A representation of the output generated when Nebari init help command is executed, the output contains a list of the available options and arguments and their use. ](/img/get-started/nebari-init-help-2.png "Nebari's init help command line output")
<img src="/img/get-started/nebari-init-help-2.png" alt="nebari CLI init command --help command output" longdesc="The nebari init --help displays the usage and optional arguments for the command which takes Cloud provider as a mandatory input. Other optional arguments are: guided init, namespace, auth provider, domain name, repository, repository auto provision, ci provider, terraform state, Kubernetes version, SSL cert email, help "/>

ericdatakelly
ericdatakelly reviewed Nov 15, 2022
View reviewed changes
docs/docs/how-tos/nebari-aws.md
@@ -115,7 +115,7 @@ environment variables have been properly set. It is time to initialize and deplo
nebari init --guided-init
```

![A representation of the output generated when Nebari init guided-init command is executed.](/img/how-tos/nebari-aws.png)
![A representation of the output generated when Nebari init guided-init command is executed. ](/img/how-tos/nebari-aws.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'll work on this.

Copy link
Contributor

Choose a reason for hiding this comment

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

@pavithraes It might be better to add more description to the text above instead of the alt text on a screenshot. I'm also wondering if the screenshot could be pasted in as a code block instead of an image. What do you think?

ericdatakelly
ericdatakelly reviewed Nov 15, 2022
View reviewed changes
docs/docs/how-tos/nebari-aws.md
@@ -115,7 +115,7 @@ environment variables have been properly set. It is time to initialize and deplo
nebari init --guided-init
```

![A representation of the output generated when Nebari init guided-init command is executed.](/img/how-tos/nebari-aws.png)
![A representation of the output generated when Nebari init guided-init command is executed. ](/img/how-tos/nebari-aws.png)
Copy link
Contributor

@ericdatakelly ericdatakelly Nov 15, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
![A representation of the output generated when Nebari init guided-init command is executed. ](/img/how-tos/nebari-aws.png)
<img src="/img/how-tos/nebari-aws.png" alt="CLI output and responses after executing command nebari init --guided-init" longdesc="The command nebari init --guided-init asks the user some questions and the first two questions are shown here. The first one asks where there kubernetes cluster should be deployed. User response is 'aws'. The user is prompted to enter their AWS access key id and AWS secret access key. Then the user is asked what the project name should be. The user responds with 'project-name'."/>

ericdatakelly
ericdatakelly reviewed Nov 15, 2022
View reviewed changes
docs/docs/how-tos/nebari-aws.md
@@ -181,7 +181,7 @@ To see all the options available for the deploy command, run the following comma
nebari deploy --help
```

![A representation of the output generated when nebari deploy help command is executed.](/img/how-tos/nebari-deploy-help.png)
![A representation of the output generated when nebari deploy help command is executed. ](/img/how-tos/nebari-deploy-help.png)

This comment was marked as resolved.

Sign in to view

This comment was marked as resolved.

Sign in to view

ericdatakelly
ericdatakelly reviewed Nov 15, 2022
View reviewed changes
docs/docs/how-tos/nebari-aws.md
@@ -181,7 +181,7 @@ To see all the options available for the deploy command, run the following comma
nebari deploy --help
```

![A representation of the output generated when nebari deploy help command is executed.](/img/how-tos/nebari-deploy-help.png)
![A representation of the output generated when nebari deploy help command is executed. ](/img/how-tos/nebari-deploy-help.png)
Copy link
Contributor

@ericdatakelly ericdatakelly Nov 15, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
![A representation of the output generated when nebari deploy help command is executed. ](/img/how-tos/nebari-deploy-help.png)
<img src="/img/how-tos/nebari-deploy-help.png" alt="CLI output after executing command nebari deploy --help" longdesc="The command nebari deploy --help displays its usage and arguments. The --config argument is a required path to the Nebari configuration yaml file. Optional arguments are output, dns-provider, dns-auto-provision, disable-prompt, disable-render, and help."/>

ericdatakelly
ericdatakelly reviewed Nov 15, 2022
View reviewed changes
docs/docs/how-tos/nebari-aws.md
@@ -225,7 +225,7 @@ To see all the options available for the destroy command, type the following com
nebari destroy --help
```

![A representation of the output generated when nebari deploy help command is executed.](/img/how-tos/nebari-destroy-help.png)
![A representation of the output generated when nebari deploy help command is executed. ](/img/how-tos/nebari-destroy-help.png)
Copy link
Contributor

@ericdatakelly ericdatakelly Nov 15, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
![A representation of the output generated when nebari deploy help command is executed. ](/img/how-tos/nebari-destroy-help.png)
<img src="/img/how-tos/nebari-destroy-help.png" alt="CLI output after executing command nebari destroy --help" longdesc="The command nebari destroy --help displays its usage and arguments. The --config argument is a required path to the Nebari configuration yaml file. Optional arguments are output, disable-render, and help."/>

ericdatakelly
ericdatakelly reviewed Nov 15, 2022
View reviewed changes
docs/docs/how-tos/nebari-aws.md
@@ -225,7 +225,7 @@ To see all the options available for the destroy command, type the following com
nebari destroy --help
```

![A representation of the output generated when nebari deploy help command is executed.](/img/how-tos/nebari-destroy-help.png)
![A representation of the output generated when nebari deploy help command is executed. ](/img/how-tos/nebari-destroy-help.png)

Nebari also has a `destroy` command that works the same way the deploy works but instead of creating the provisioned resources it destroys it.
Copy link
Contributor

Choose a reason for hiding this comment

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

Move this sentence up. It should be the first sentence after the heading Destroying Nebari.

@kcpevey
Copy link
Contributor

kcpevey commented Mar 22, 2023

@pavithraes looks like we have many suggestions here. I propose we get these merged and open a new PR for the next sprint when the time comes.

@kcpevey kcpevey mentioned this pull request Mar 22, 2023
Closed
@pavithraes pavithraes assigned pavithraes and unassigned trallard Apr 24, 2023
@pavithraes pavithraes added the status: in review 👀 This PR is currently being reviewed by the team label Apr 24, 2023
@viniciusdc
Copy link
Contributor

@pavithraes whats the status on this one?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ericdatakelly ericdatakelly ericdatakelly left review comments

@trallard trallard trallard left review comments

@gabalafou gabalafou gabalafou left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@pavithraes pavithraes

Labels
area: accessibility ♿️ Accessibility related features or issues area: documentation 📖 DO-NOT-MERGE This is not ready for merge status: in review 👀 This PR is currently being reviewed by the team type: enhancement 💅🏼 New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] - Add/update alt text throughout documentation
6 participants
@pavithraes @kcpevey @viniciusdc @gabalafou @trallard @ericdatakelly