[WIP] Sprint: Add/update alt-text for images #222
Draft
+58
−58
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for nebari-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
pavithraes
changed the title
pavithraes
added
type: enhancement 💅🏼
pavithraes
commented
Nov 14, 2022
| @@ -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} /> | |||
There was a problem hiding this comment.
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} /> |
There was a problem hiding this comment.
(As mentioned on call) We don't need this one because it's redundant.
gabalafou
reviewed
Nov 14, 2022
| @@ -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: | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
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
|  | |
|  |
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
commented
Nov 14, 2022
| @@ -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). | |||
|
|
|||
|  | |||
|  | |||
gabalafou
reviewed
Nov 14, 2022
| @@ -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: | |||
There was a problem hiding this comment.
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
reviewed
Nov 14, 2022
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. |
There was a problem hiding this comment.
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
reviewed
Nov 14, 2022
| @@ -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. | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
Suggested change
|  | |
|  |
gabalafou
reviewed
Nov 14, 2022
|
|
||
| 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! | ||
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
Suggested change
|  | |
|  |
trallard
reviewed
Nov 14, 2022
| @@ -75,7 +75,7 @@ You can pass the `--help` flag to the `init` command to check all the arguments | |||
| nebari init --help | |||
| ``` | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
Suggested change
|  | |
| <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 "/> |
| @@ -115,7 +115,7 @@ environment variables have been properly set. It is time to initialize and deplo | |||
| nebari init --guided-init | |||
| ``` | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
@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?
| @@ -115,7 +115,7 @@ environment variables have been properly set. It is time to initialize and deplo | |||
| nebari init --guided-init | |||
| ``` | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
Suggested change
|  | |
| <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'."/> |
| @@ -181,7 +181,7 @@ To see all the options available for the deploy command, run the following comma | |||
| nebari deploy --help | |||
| ``` | |||
|
|
|||
|  | |||
|  | |||
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
| @@ -181,7 +181,7 @@ To see all the options available for the deploy command, run the following comma | |||
| nebari deploy --help | |||
| ``` | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
Suggested change
|  | |
| <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."/> |
| @@ -225,7 +225,7 @@ To see all the options available for the destroy command, type the following com | |||
| nebari destroy --help | |||
| ``` | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
Suggested change
|  | |
| <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."/> |
| @@ -225,7 +225,7 @@ To see all the options available for the destroy command, type the following com | |||
| nebari destroy --help | |||
| ``` | |||
|
|
|||
|  | |||
|  | |||
|
|
|||
| Nebari also has a `destroy` command that works the same way the deploy works but instead of creating the provisioned resources it destroys it. | |||
There was a problem hiding this comment.
Move this sentence up. It should be the first sentence after the heading Destroying Nebari.
|
@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. |
pavithraes
added
the
status: in review 👀
|
@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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
xin the boxes that applyTesting
Documentation
Access-centered content checklist
Text styling
H1or#in markdown).Non-text content
Any other comments?