AWS account reqs nearly done

Teradata · May 6, 2024 · dc1f6ef · dc1f6ef
1 parent 427bb8d
commit dc1f6ef
Show file tree

Hide file tree

Showing 17 changed files with 179 additions and 197 deletions.
diff --git a/docs/explore-and-analyze-data/create-first-project.md b/docs/explore-and-analyze-data/create-first-project.md
@@ -24,7 +24,7 @@ You'll complete this simple workflow:
 
 ## Before you begin
 
-- From your AI Unlimited admin, get these items:
+- From your AI Unlimited admin (the person at your organization who installed and set up AI Unlimited), get these items:
 
 	- The ip or host name for the AI Unlimited manager
 
@@ -48,7 +48,7 @@ You'll complete this simple workflow:
 - Connect to JupyterLab, open a notebook, and select the AI Unlimited kernel.
 
 :::note
-If you don't have JupyterLab or the AI Unlimited kernel, see [Jupyter installaton options](/docs/advanced/jupyterlab).
+If you don't have JupyterLab or the AI Unlimited kernel, see [Jupyter installation options](/docs/advanced/jupyterlab).
 :::
 
 ## Connect, and run your first workload
@@ -84,7 +84,7 @@ Run `%help` or `%help <command>` for details on all magic commands or any one of
 
     Replace `ACCESS_KEY_ID`, `SECRET_ACCESS_KEY`, and `REGION` with your values.
     ```bash
-    %project_auth_create name=<Auth_Name>, project=<Project_Name>, key=<ACCESS_KEY_ID>, secret=<SECRET_ACCESS_KEy>, region=<REGION>
+    %project_auth_create name=<Auth_Name>, project=<Project_Name>, key=<ACCESS_KEY_ID>, secret=<SECRET_ACCESS_KEY>, region=<REGION>
     ```
 	
 	***These look like AWS. Do AWS-Azure tabs?***

diff --git a/docs/explore-and-analyze-data/get-api-key.md b/docs/explore-and-analyze-data/get-api-key.md
@@ -0,0 +1,31 @@
+---
+id: get-api-key
+title: Get your API key
+description: You'll need your API key whenever you connect to the engine from a Jupyter notebook.
+sidebar_position: 1
+sidebar_label: Get your API key
+pagination_prev: null
+pagination_next: null
+---
+
+# Get your API key
+
+***WIP***
+
+***(Explain what it is, the entities the handshake is between, etc.)***
+
+***(will also tell them how to get it in Create your first project)***
+
+You'll need your API key each time you create a project, or access an existing one, from a Jupyter notebook.
+
+1. Access the AI Unlimited setup using the URL provided to you by your AI Unlim admin: `http://[ip_or_hostname]:[port]`.
+:::note
+The AI Unlimited admin is the person at your organization who set up AI Unlimited.
+:::
+2. Sign in, as you normally do to GitHub or GitLab.
+3. Go to your **Profile**, and copy your API key.
+
+
+
+
+
diff --git a/docs/explore-and-analyze-data/index.md b/docs/explore-and-analyze-data/index.md
@@ -13,7 +13,7 @@ pagination_next: null
 Connect to JupyterLab, open a notebook, and select the AI Unlimited kernel.
 
 :::note
-If you don't have JupyterLab or the AI Unlimited kernel, see [Jupyter installaton options](/docs/advanced/jupyterlab).
+If you don't have JupyterLab or the AI Unlimited kernel, see [Jupyter installation options](/docs/advanced/jupyterlab).
 :::
 
 

diff --git a/docs/explore-and-analyze-data/magic-commands.md b/docs/explore-and-analyze-data/magic-commands.md
@@ -12,6 +12,8 @@ import TabItem from '@theme/TabItem';
 
 # Magic commands
 
+In Jupyter notebooks, magic commands are special shortcuts that starts with %. They let you do more than just run programming language.
+
 JupyterLab with the AI Unlimited kernel supports these magic commands in addition to the existing Teradata SQL kernel magic commands. 
 
 ## %workspaces_config

diff --git a/docs/install-ai-unlimited/index.md b/docs/install-ai-unlimited/index.md
@@ -40,7 +40,7 @@ If AI Unlimited has already been installed and set up by someone at your organiz
 - JupyterLab
 
 :::tip
-When you install the manager, you'll provide values for some cloud deployment details. See the [AWS details](/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md#aws-parms) or [Azure details](/docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md#azure-parms)&mdash;if you want to work with a cloud admin ***(final term TBD)*** to get the values ahead of time.
+When you install the manager, you'll provide values for some cloud deployment details. See the [AWS details](/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md#aws-parms) or [Azure details](/docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md#azure-parms)&mdash;if you want to work with a cloud admin to get the values ahead of time.
 :::
 
 ***maybe we no longer want the note that follows - too confusing with the new option to deploy from the marketplace - might depend on the name of the new deployment method***

diff --git a/docs/install-ai-unlimited/new-setup-ui_for-post-ppp.md b/docs/install-ai-unlimited/new-setup-ui_for-post-ppp.md
diff --git a/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md b/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md
@@ -29,7 +29,7 @@ CloudFormation templates for the manager are here in the AI Unlimited GitHub rep
 
 1. Choose a template based on the type of [load balancer](/docs/glossary.md#glo-load-balancer) you want to use.<br /> 
    :::note
-   You might want to ask an admin at your organization for guidance.
+   You might want to ask a cloud admin at your organization for guidance.
    :::
     - `ai-unlimited-with-alb.yaml`&mdash;Hosts the manager behind an [application load balancer](/docs/glossary.md#glo-application-load-balancer)
     - `ai-unlimited-with-nlb.yaml`&mdash;Hosts the manager behind a [network load balancer](/docs/glossary.md#glo-network-load-balancer)
@@ -88,7 +88,7 @@ We recommend selecting the region closest to your primary work location.
 |AIUnlimitedHttpPort		|The port to access the AI Unlimited UI.|Required with default<br/>Default: 3000|
 |AIUnlimitedGrpcPort		|The port to access the AI Unlimited API.|Required with default<br/>Default: 3282|
 |AIUnlimitedVersion		|The version of AI Unlimited you want to deploy.|Required with default<br/>Default: latest<br/>The value is a container version tag.|
-|UsePersistentVolume|Specifies whether you want to use a persistent volume to store data. See *Learn more: Why use a persistent volume?* below the parameters table. |Optional with default<br/>Default: None<br/>Supported options are: new persistent volume, an existing one, or none, depending on your use case.|
+|UsePersistentVolume|Specifies whether you want to use a persistent volume to store data. See *Learn more: Why use a persistent volume?* below the parameters section. |Optional with default<br/>Default: None<br/>Supported options are: new persistent volume, an existing one, or none, depending on your use case.|
 |PersistentVolumeSize	|The size of the persistent volume that you attach to the instance, in GB.|Required with default<br/>Default: 8<br/>Supports values between 8 and 1000. |
 |ExistingPersistentVolumeId		|The ID of the existing persistent volume that you attach to the instance. |Required if UsePersistentVolume is set to Existing.<br/>Default: NA<br/>The persistent volume must be in the same availability zone as the AI Unlimited instance.|
 |PersistentVolume<br/>DeletionPolicy		|The persistent volume behavior when you delete the CloudFormation deployment.|Required with default|Delete <br/>Default: NA <br/>Supported options are: Delete, Retain, RetainExceptOnCreate, and Snapshot.|
@@ -110,7 +110,7 @@ If the container, pod, or node crashes or terminiates, you lose the manager's co
 
 #### With a persistent volume
 
-If the container, pod, or node crashes or terminates, and the manager's configuration data is stored in a persisent volume, you can deploy a new manager instance that has the same configuration as the one that was lost.
+If the container, pod, or node crashes or terminates, and the manager's configuration data is stored in a persistent volume, you can deploy a new manager instance that has the same configuration as the one that was lost.
 
 #### Example
 

diff --git a/docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md b/docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md
@@ -10,8 +10,6 @@ pagination_next: null
 
 # Install the manager on Azure
 
-(cloud admin - **final term TBD**)
-
 Before you begin, make sure you have the [prerequisites](/docs/install-ai-unlimited/#gs-prerequisties).
 
 The AI Unlimited manager orchestrates the engine's deployment and includes a web-based user interface for monitoring projects. And the manager is where you'll set up AI Unlimited. 

diff --git a/docs/install-ai-unlimited/setup-ai-unlimited.md b/docs/install-ai-unlimited/setup-ai-unlimited.md
@@ -15,6 +15,11 @@ import TabItem from '@theme/TabItem';
 
 After you install the manager, access the AI Unlimited setup using the URL you received at the end of the installation process: `http://[ip_or_hostname]:[port]`. 
 
+:::note
+By setting up AI Unlimited, you become the AI Unlimited admin at your organization.
+:::
+
+
 ## Complete the fields
 
 You'll find information about each group of fields here.
@@ -24,7 +29,7 @@ You'll find information about each group of fields here.
 <summary>Initial setup</summary>
 
 <br />
-**AI Unlimited base URL**&mdash;***(label will change)***The URL you used to access the setup. You received it when you installed the manager.
+**AI Unlimited base URL**&mdash;***(label will change)*** The URL you used to access the setup. You received it when you installed the manager.
 
 **Note:** We've used the term "manager" to refer to the AI Unlimited component you installed. Now that it's installed, its user interface and underlying functionality are simply "AI Unlimited."  
 
@@ -173,10 +178,12 @@ Select **Authenticate**. Then, if prompted, sign in.
 
 2. If you enabled TLS, select **Restart**. This restarts the AI Unlimited service with TLS in place.
 
-***(ok to get their API key before restarting, if they enabled TLS, that is)***
-
 AI Unlimited setup is now complete.
 
+:::note
+Because you are now the AI Unlimited admin, you can return to the setup anytime, as needed, to changes settings. Use the same URL, and sign in.
+:::
+
 
 ## What's next
 

diff --git a/docs/manage-ai-unlimited/change-settings.md b/docs/manage-ai-unlimited/change-settings.md
@@ -14,12 +14,12 @@ pagination_next: null
 
 ***Needs 2 separate topics - old UI vs. new UI.***
 
-If you are the AI Unlimited administrator, you can change AI Unlimited settings. 
+If you are the AI Unlimited admin, you can change AI Unlimited settings. 
 
 ***(make clear what they can/would change and why)***
 
 :::note
-The user who [set up AI Unlimited](/docs/install-ai-unlimted/setup-ai-unlimited.md) is the administrator.
+The user who [set up AI Unlimited](/docs/install-ai-unlimted/setup-ai-unlimited.md) is the admin.
 :::
 
 1. Access the manager ***(more details)***, sign in to your GitHub or GitLab account... how to say that... ***(will watch recording)***

diff --git a/docs/manage-ai-unlimited/index.md b/docs/manage-ai-unlimited/index.md
@@ -24,8 +24,8 @@ A user who creates a project is the project's owner.
 - [Add collaborators](/docs/manage-ai-unlimited/add-collaborators.md)
 
 
-## Administrator
+## Admin
 
-The user who [set up AI Unlimited](/docs/install-ai-unlimited/setup-ai-unlimited.md) is the administrator.
+The user who [set up AI Unlimited](/docs/install-ai-unlimited/setup-ai-unlimited.md) is the admin.
 
 - [Change overall settings](/docs/manage-ai-unlimited/change-settings.md) ***(will explain this better - what does this really mean)***