[WIP] Sprint: Add/update alt-text for images #222
+58
−58
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -40,20 +40,20 @@ After the initial deployment, it is **highly** recommended that you change the K | |
| 1. To change the `root` user password, go to your Nebari instance's admin dashboard - e.g., something like `https://{your-nebari-domain}/auth/admin/` and log in with the root password provided. | ||
|
|
||
| <p align="center"> | ||
| <img src="/img/how-tos/keycloak_master_login.png" alt="Nebari admin view - Root Login to Keycloak form " width="400"/> | ||
| </p> | ||
|
|
||
| 2. From there, click on the **Root** dropdown in the top right of the screen, and select **Manage account**. | ||
|
|
||
|  | ||
|
|
||
| 3. Under **Account Security** click **Signing In**. | ||
|
|
||
|  | ||
|
|
||
| 4. In the Password section, click the **Update** button. This will guide you through entering your existing root password, and then creating a new password. | ||
|
|
||
|  | ||
|
|
||
| :::warning | ||
| The `security.keycloak.initial_root_password` field in `nebari-config.yaml` has no effect after changing the `root` password. If you redeploy Nebari it **will not reset** the password back to the old one (or anything else that might be in the field in your YAML file). We strongly recommend you delete this field to prevent later confusion. | ||
|
|
@@ -83,7 +83,7 @@ Steps to create a new user: | |
|
|
||
| 2. Click the **Add user** button, and you will see the new user form: | ||
|
|
||
|  | ||
|
|
||
| 3. Fill out the three fields outlined above. These are **Username**, **Email**, and **Groups**. (See explanation below). Then click **save**. | ||
|
|
||
|
|
@@ -110,7 +110,7 @@ If you are using the password authentication provider, you will also need to def | |
| If using Auth0, GitHub or any other identity provider, the password field is not required. | ||
| ::: | ||
|
|
||
|  | ||
|
|
||
| ### Add user from the command line | ||
|
|
||
|
|
@@ -130,7 +130,7 @@ This will create a new user `<username>` under the `analyst` group, with the ini | |
|
|
||
| Your new user can now log in to Nebari, visit your provided Nebari domain URI which will take you to the login form page and follow the [How-to login in to Nebari and start a server][keycloak-login]. | ||
|
|
||
|  | ||
|
|
||
| ## In-depth look at Roles and Groups | ||
|
|
||
|
|
@@ -162,15 +162,15 @@ As an example, we create a new group named `conda-store-manager`. This group wil | |
|
|
||
| 1. Click **New** in the upper-right hand corner under **Groups**. | ||
|
|
||
| ![Keycloak groups tab screenshot - user groups view] (/img/how-tos/keycloak_groups.png) | ||
|
|
||
| - Then, give the new group an appropriate name. | ||
|
|
||
|  | ||
|
|
||
| 2. Under **Role Mapping**, add the appropriate **Client Roles** as needed; there should be no need to update the **Realm Roles**. | ||
|
|
||
|  | ||
|
|
||
| In this example, the new group only has one mapped role, `conda_store_admin`; however, it's possible to attach multiple **Client Roles** to a single group. | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -100,7 +100,7 @@ configuration in the `kubeconfig` to dial the connection with the cluster. | |
|
|
||
| To view all the current processes press 0: | ||
|
|
||
|  | ||
|
|
||
| Using `k9s` you can inspect any services launched by your cluster. For | ||
| example, if your cluster has problems with the network traffic tunnel | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,15 +36,15 @@ To generate a token follow the steps below. For additional information, see the | |
|
|
||
| - Under Profile, select the API Tokens menu and click on Create API Token. | ||
|
|
||
| - On Edit zone DNS click on Use Template.. | ||
|
|
||
| - Configure Permissions such as the image below: | ||
|
|
||
| - On Account Resources set the configuration to include your desired account. | ||
|
|
||
| - On Zone Resources set it to Include | Specific zone and your domain name. | ||
|
|
||
| - Click continue to summary. | ||
|
|
||
| - Click on the Create Token button and set the token generated as an environment variable on your machine. | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,7 +16,7 @@ Navigate to the cluster homepage, for instance [`https://demo.nebari.dev`](https | |
| Once on the site, you will be prompted to log in, similar to | ||
| the login page shown in the image below. | ||
|
|
||
|  | ||
|
|
||
| Nebari uses [Keycloak](https://www.keycloak.org/), an open-source identity and access management tool. Keycloak is a centralized location for administrators to add new users, create user groups and update roles. For more information, see the [How to Configure Keycloak][nebari-keycloak] docs. | ||
|
|
||
|
|
@@ -33,12 +33,12 @@ For more information on how to configure Keycloak, and add new users, review the | |
| In this example, Auth0 is acting as our identity provider. To continue the login process, the user selects the `Auth0` button and logs into through Auth0. | ||
|
|
||
| <p align="center"> | ||
| <img src="/img/how-tos/keycloak_nebari_login.png" alt="Nebari Keycloak auth screen - shows a form to provide username or password or to authenticate through Auth0 " width="400"/> | ||
| </p> | ||
|
|
||
| Once authenticated, you will be forwarded to the main JupyterHub page. On this page, you will find links to all of Nebari's core features, and it is where you can launch your JupyterLab pod. If you are an admin, you'll also have access to the JupyterHub `Admin` management. | ||
|
|
||
|  | ||
|
|
||
| ## 3. Selecting a Profile | ||
|
|
||
|
|
@@ -49,22 +49,22 @@ The customized profiles will give you access to fixed cloud resources. In this e | |
| These options are configured by your administrator. A more detailed explanation of dedicated profiles can be found in the Profiles section of | ||
| the advanced configuration page. | ||
|
|
||
|  | ||
|
|
||
| ## 4. Starting your server | ||
|
|
||
| Once an appropriate profile has been selected, click `start`. At this point, your JupyterLab pod instance will be launched. This step may take up to several minutes due to Nebari use of autoscaling under the hood. | ||
|
|
||
| Ultimately this autoscaling feature helps reduce costs when the cluster is idle. A successful launch should look similar to the image below. | ||
|
|
||
|  | ||
|
|
||
| <details> | ||
| <summary>Event Log</summary> | ||
|
|
||
| During this time you might see some log messages that detail the autoscaling process. To view all the logs, click the **Event Log** button. They should look similar to the following: | ||
|
|
||
|  | ||
|
|
||
| </details> | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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? There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| :::tip | ||||||
| If you prefer not using the `guided-init` command then you can directly run the `init` command. | ||||||
|
|
@@ -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.
Sorry, something went wrong.
This comment was marked as resolved.
Sorry, something went wrong. There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| With the `nebari-config.yaml` configuration file now created, Nebari can be deployed for the first time. Type the following command on your command line: | ||||||
|
|
||||||
|
|
@@ -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
|
||||||
|
|
||||||
| 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 |
||||||
|
|
||||||
|
|
||||||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -97,7 +97,7 @@ environment variables have been properly set. It is time to initialize and deplo | |
| nebari init --guided-init | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| :::tip | ||
| If you prefer not using the `guided-init` command then you can directly run the `init` command. | ||
|
|
@@ -163,7 +163,7 @@ To see all the options available for the deploy command, run the following comma | |
| nebari deploy --help | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| With the `nebari-config.yaml` configuration file now created, Nebari can be deployed for the first time. Type the following command on your command line: | ||
|
|
||
|
|
@@ -207,7 +207,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. | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -82,11 +82,11 @@ Here, we outline how to find and destroy resources from the AWS console. | |
|
|
||
| 1. Sign in to your AWS account and in the search bar type `Tag Editor` | ||
|
|
||
| <img src="/img/how-tos/aws_tag_editor_1.png" alt="Search for Tag Editor in the AWS console " width="700"/> | ||
|
|
||
| 2. From the `Resource Groups & Tag Editor` page, navigate to `Tag Editor` from the left most panel | ||
|
|
||
| <img src="/img/how-tos/aws_tag_editor_2.png" alt="Navigate to the Tag Editor in the AWS console " width="200"/> | ||
|
|
||
| 3. Fill out the form as follows: | ||
| - `Regions` - the region you deployed your Nebari cluster (or select `all regions`) | ||
|
|
@@ -95,7 +95,7 @@ Here, we outline how to find and destroy resources from the AWS console. | |
| - select `Environment` for key (on the left) | ||
| - enter the namespace you chose for your Nebari cluster (on the right) | ||
|
|
||
| <img src="/img/how-tos/aws_tag_editor_3.png" alt="Use the Tag Editor to filter for lingering Nebari resources " width="700"/> | ||
|
|
||
| 4. From here you can filter further if needed by entering the name of your Nebari cluster. | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -95,7 +95,7 @@ environment variables have been properly set. It is time to initialize and deplo | |
| nebari init --guided-init | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| :::tip | ||
| If you prefer not using the `guided-init` command then you can directly run the `init` command. | ||
|
|
@@ -161,7 +161,7 @@ To see all the options available for the deploy command, run the following comma | |
| nebari deploy --help | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| With the `nebari-config.yaml` configuration file now created, Nebari can be deployed for the first time. Type the following command on your command line: | ||
|
|
||
|
|
@@ -203,7 +203,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. | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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.