mostly Other Resources clean up

Teradata · Apr 26, 2024 · e8d683e · e8d683e
1 parent 99cf3a0
commit e8d683e
Show file tree

Hide file tree

Showing 14 changed files with 114 additions and 102 deletions.
diff --git a/docs/advanced/deployment-details.md b/docs/advanced/deployment-details.md
@@ -2,7 +2,7 @@
 id: deployment-details
 title: Cloud deployment details
 description: Deployment details to get ahead of time
-sidebar_label: Get cloud deployment details
+sidebar_label: Get deployment details
 sidebar_position: 5
 pagination_prev: null
 pagination_next: null
@@ -12,20 +12,21 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
 
-# Get cloud deployment details
+# Get deployment details
 
-***WIP***
+:::note
+These details do not apply to the QuickStart.
+:::
 
-## Get deployment details
+When you install the AI Unlimited manager from your cloud service provider's console, you'll provide values for required parameters. 
+
+You can get the values from your cloud service provider's console. Or, copy the parameter names shown here, and ask an admin for their values.
 
 <Tabs>
 <TabItem value="aws1" label="AWS">
-When you install the manager using the CloudFormation template, you provide account and network details. 
-
-You can copy this template to get these details from an admin. Or, get them from the AWS Management Console.
 
 	```bash
-    Subscription ID: 
+	Subscription ID: 
     Resource Group:
     AWS Region: 
     Virtual Network (VNet): 
@@ -37,10 +38,6 @@ You can copy this template to get these details from an admin. Or, get them from
 </TabItem>
 <TabItem value="azure" label="Azure">
 
-When you install the manager using the Azure Resource Manager (ARM) template, and you provide network and security details. 
-
-You can copy this template to get these details from an admin. Or, get them from the Azure Portal.
-
 	```bash
 Subscription: 
 Region: 

diff --git a/docs/advanced/git-requirements.md b/docs/advanced/git-requirements.md
@@ -1,20 +1,21 @@
 ---
 id: git-requirements
-title: GitHub/GitLab requirements
-description: How to prepare your GitHub or GitLab account
-sidebar_label: GitHub/GitLab requirements
+title: Git requirements
+description: Get the Teradata-provided repository and create an OAuth app.
+sidebar_label: Git requirements
 sidebar_position: 4
 pagination_prev: null
 pagination_next: null
 ---
 
-# GitHub/GitLab requirements
+# Git requirements
+
+Make sure you have a GitHub or GitLab account, and complete these tasks.
 
-***WIP***
 
 ## Clone the provided repository
 
-Clone the [AI Unlimited GitHub repository](https://github.com/Teradata/ai-unlimited). The `deployments` folder in the repository contains template, parameter, and policy files for installing AI Unlimited. 
+The `deployments` folder in the [AI Unlimited GitHub repository](https://github.com/Teradata/ai-unlimited) contains template, parameter, and policy files for installing AI Unlimited.
 
 	Open a terminal window, and clone the repository.
 
@@ -25,6 +26,21 @@ Clone the [AI Unlimited GitHub repository](https://github.com/Teradata/ai-unlimi
 
 ## Create a GitHub or GitLab OAuth app
 
-import MyPartial from '/docs/_partials/_create-oauth-app.mdx';
+Create an [OAuth](https://oauth.net/2/) app so that AI Unlimited can authorize your GitHub or GitLab account to store user and project information.
+
+1. Sign in to your GitHub or GitLab account. 
+
+2. Create an OAuth app. See [GitHub: Create an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) or [GitLab: Create an OAuth app](https://docs.gitlab.com/ee/integration/oauth_provider.html).
+
+    While registering the OAuth app, use these URLs.
+
+    - Homepage URL: 
+	  - If you are using the QuickStart, `http://localhost:3000`
+      - For a demo or full installation, `http://[ip_or_hostname]:[port]`
+	  
+	  
+    - Authorization callback URL: `[Homepage URL]/auth/github/callback`
+
+    For GitLab, select the appropriate OAuth **Scopes** as defined in [Authorized Applications](https://docs.gitlab.com/ee/integration/oauth_provider.html#view-all-authorized-applications).
 
-<MyPartial />
+3.	Copy and retain the **Client ID** and **Client secret**. You'll use them to authorize AI Unlimited to save user and project information.
diff --git a/docs/advanced/jupyterlab/index.md b/docs/advanced/jupyterlab/index.md
@@ -16,3 +16,7 @@ Or, get JupyterLab with the AI Unlimited kernel now:
 
 - Install it on [AWS](/docs/advanced/jupyterlab/install-jupyterlab-aws.md) or on [Azure](/docs/advanced/jupyterlab/install-jupyterlab-azure.md)
 - [Run it locally](/docs/advanced/jupyterlab/run-jupyterlab-docker.md) in a Docker container
+
+:::note
+The [QuickStart](/docs/advanced/quickstart) includes JupterLab. If you plan to use the QuickStart, you do not need to install JupyterLab separately.
+:::
diff --git a/docs/advanced/jupyterlab/install-jupyterlab-aws.md b/docs/advanced/jupyterlab/install-jupyterlab-aws.md
@@ -2,26 +2,26 @@
 id: deploy-jupyter-aws-console
 title: Deploy JupyterLab from the AWS Management Console
 description: Learn how to deploy JupyterLab using a Cloudformation template.
-sidebar_label: AWS
+sidebar_label: Install on AWS
 sidebar_position: 1
 pagination_prev: null
 pagination_next: null
 ---
 
-# Deploy the template from the AWS Management Console
+# Install JupyterLab on AWS
 
-The CloudFormation template deploys a server instance with JupyterLab, and the AI Unlimited kernel, running in a container controlled by [systemd](/docs/glossary.md#glo-systemd).
+You'll use a CloudFormation template provided by Teradata to install JupyterLab, and the AI Unlimited kernel, from the AWS Management Console. 
+
+This deploys a server instance, with JupyterLab running in a container controlled by [systemd](/docs/glossary.md#glo-systemd).
+
+:::tip
+For installation support, ask the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa).
+:::
 
 :::note
 References to the AWS Management Console are accurate as of April 11, 2024.
 :::
 
-## Clone the AI Unlimited GitHub repository
-
-import MyPartial from '/docs/_partials/_clone-repo.mdx';
-
-<MyPartial />
-
 
 ## Download the Jupyter template
 

diff --git a/docs/advanced/jupyterlab/install-jupyterlab-azure.md b/docs/advanced/jupyterlab/install-jupyterlab-azure.md
@@ -2,27 +2,26 @@
 id: deploy-jupyter-azure-portal
 title: Deploy JupyterLab from the Azure Portal
 description: Learn how to deploy JupyterLab using an ARM template.
-sidebar_label: Azure 
+sidebar_label: Install on Azure 
 sidebar_position: 2
 pagination_prev: null
 pagination_next: null
 ---
 
-# Deploy the template from the Azure Portal
+# Install JupyterLab on Azure
 
-The Azure Resource Manager (ARM) template deploys a server instance with JupyterLab, and the AI Unlimited kernel, running in a container controlled by [systemd](/docs/glossary.md#glo-systemd).
+You'll use an  Azure Resource Manager (ARM) template provided by Teradata to install JupyterLab, and the AI Unlimited kernel, from the Azure Portal. 
+
+This deploys a server instance, with JupyterLab running in a container controlled by [systemd](/docs/glossary.md#glo-systemd).
+
+:::tip
+For installation support, ask the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa).
+:::
 
 :::note
 References to the Azure Portal are accurate as of April 14, 2024.
 ::: 
 
-## Clone the AI Unlimited GitHub repository
-
-import MyPartial from '/docs/_partials/_clone-repo.mdx';
-
-<MyPartial />
-
-
 ## Download the Jupyter template
 
 Download the template (`/deployments/azure/jupyter.json`) from the AI Unlimited GitHub repository you cloned.

diff --git a/docs/advanced/jupyterlab/run-jupyterlab-docker.md b/docs/advanced/jupyterlab/run-jupyterlab-docker.md
@@ -2,7 +2,7 @@
 id: run-jupyter-docker
 title: Run JupyterLab locally using Docker
 description: Learn how to run JupyterLab with the AI Unlimited Jupyter Kernel on your computer.
-sidebar_label: Docker
+sidebar_label: Run locally using Docker
 sidebar_position: 3
 pagination_prev: null
 pagination_next: null
@@ -11,42 +11,41 @@ pagination_next: null
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Run JupyterLab locally
+# Run JupyterLab locally using Docker
 
-Use [Docker Compose](https://docs.docker.com/compose/) to run JupyterLab, with the AI Unlimited Jupyter Kernel, locally in a container.
-
+You'll use [Docker Compose](https://docs.docker.com/compose/) to run JupyterLab, with the AI Unlimited Jupyter Kernel, locally in a container.
 
-## Clone the AI Unlimited GitHub repository
-
-import MyPartial from '/docs/_partials/_clone-repo.mdx';
-
-<MyPartial />
+:::tip
+For installation support, ask the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa).
+:::
 
 
 ## Set a location for JupyterLab configuration files
 
+Optionally, set the `JUPYTER_HOME` environment variable to the directory in which to store the JupyterLab configuration files. The default location is `~/.jupyter`.
+
 :::tip
 Learn about [AWS](https://docs.aws.amazon.com/sdkref/latest/guide/environment-variables.html) or [Azure](https://github.com/paulbouwer/terraform-azure-quickstarts-samples/blob/master/README.md#azure-authentication) environment variables.
 :::
 
-Optionally, set the `JUPYTER_HOME` environment variable to the directory in which to store the JupyterLab configuration files. The default location is `~/.jupyter`.
-
 
 ## Start JupyterLab
 
 1. Go to the directory where `jupyter.yaml` is located, and start JupyterLab.
 
-```bash title="Run the Docker Compose file in the background "
-docker compose -f jupyter.yaml -d up 
-```
+	```bash title="Run the Docker Compose file in the background "
+	docker compose -f jupyter.yaml -d up 
+	```
 	The command downloads and starts the JupyterLab container.
 
-2. To retrieve the Jupyter token, list the currently running containers, and identify the name of the JupyterLab container.
+2. To retrieve the Jupyter token, list the currently running containers.
 
 	```bash
 	docker ps 
 	```
 
+	And identify the name of the JupyterLab container.
+
 	Then search for occurrences of the string 'Token' in the container's logs.
 
 	```bash

diff --git a/docs/advanced/quickstart/docker-before-you-begin.md b/docs/advanced/quickstart/docker-before-you-begin.md
@@ -10,35 +10,22 @@ import TabItem from '@theme/TabItem';
 
 # Before you begin
 
-***Depending on how the BYB ends up (AWS & Azure combo?), and depending on the deployment details discussion (although, could have 3 tabs), on the QS parent page, we could tell them to install Docker. Then, we'd have just the 1 BYB for all 3. Minor wrinkle: For the QS the CSP is only for the engine, but for the full install, it's for the engine and manager.That's fine b/c we are treating the QS as an exception to the normal install--and it's content makes clear how it's different.)***
+Get ready for the QuickStart.
 
 ## Prerequisites
 
-Make sure you have the following: 
-
-- A pay-as-you-go [AWS](https://aws.amazon.com) or [Azure](https://azure.microsoft.com) account for deploying the engine
-
-- A [GitHub](https://github.com) or [GitLab](https://gitlab.com) account for user authentication and storing project information
-
-- [Docker](https://www.docker.com/get-started/) installed on your machine
-
-
-## Create a GitHub or GitLab OAuth app
-
-import MyPartial from '/docs/_partials/_create-oauth-app.mdx';
-
-<MyPartial />
+In addition to the standard [AI Unlimited prerequisites](/docs/install-ai-unlimited/#gs-prerequisties), make sure you have [Docker](https://www.docker.com/get-started/) installed on your machine.
 
 
 ## Get engine deployment details
 
 ***Any changes to make for the old UI? Keep both files - old (PPP, initially) and new (longer-term)***
 
 ***Come back to this after finishing setup.***
-
-When you [set up AI Unlimited](/docs/install-ai-unlimited/quickstart/docker-setup-b.md), you'll provide details for deploying the engine. 
 
-You can copy this template to get these details from your admin. Or, get them from your cloud service provider console or portal.
+When you [set up AI Unlimited](/docs/install-ai-unlimited/quickstart/docker-setup-b.md), you'll complete fields to provide details about deploying the engine. 
+
+You can get the values from your cloud service provider's console. Or, copy the fields shown here, and ask an admin for their values. 
 
 <Tabs>
 <TabItem value="aws" label="AWS">
@@ -57,9 +44,3 @@ Default security group
 </TabItem>
 </Tabs> 
 
-
-## Subscribe to AI Unlimited
-
-Subscribe on your cloud service provider's marketplace:
-- AWS ***(link)***
-- Azure ***(link)***
diff --git a/docs/advanced/quickstart/docker-install-ai-unlimited-jupyter.md b/docs/advanced/quickstart/docker-install-ai-unlimited-jupyter.md
@@ -11,45 +11,38 @@ import TabItem from '@theme/TabItem';
 
 # Run the manager and JupyterLab using Docker
 
-Use [Docker Compose](https://docs.docker.com/compose/) to run the AI Unlimited manager and JupyterLab, with the AI Unlimited Jupyter Kernel, locally in containers. 
-
-
-## Clone the AI Unlimited GitHub repository
+Before starting, make sure you have [what you need](/docs/advanced/quickstart/docker-before-you-begin.md). 
 
-import MyPartial from '/docs/_partials/_clone-repo.mdx';
-
-<MyPartial />
+The AI Unlimited manager orchestrates the engine's deployment and includes a web-based user interface for monitoring projects. You'll also use it to set up AI Unlimited.
 
+Use [Docker Compose](https://docs.docker.com/compose/) to run the AI Unlimited manager and JupyterLab, with the AI Unlimited Jupyter Kernel, locally in containers. 
 
-## Set locations for manager and JupyterLab configuration files
 
-:::tip
-Learn about [AWS](https://docs.aws.amazon.com/sdkref/latest/guide/environment-variables.html) or [Azure](https://github.com/paulbouwer/terraform-azure-quickstarts-samples/blob/master/README.md#azure-authentication) environment variables.
-:::
+## Set locations for the manager and JupyterLab configuration files
 
 1. Optionally, set the `AI_UNLIMITED_HOME` environment variable to the directory in which to store the manager's configuration and data files. Make sure the directory exists, and that appropriate permission is granted. The default location is `./volumes/ai-unlimited`.
 
     | **Local location** | **Container location** | **Usage** |
     |----------------|--------------------|-------|
     | $AI_UNLIMITED_HOME | /etc/td | Stores data and configuration |
 
+	:::tip
+	Learn about [AWS](https://docs.aws.amazon.com/sdkref/latest/guide/environment-variables.html) or [Azure](https://github.com/paulbouwer/terraform-azure-quickstarts-samples/blob/master/README.md#azure-authentication) environment variables.
+	:::
+
 2. Optionally, set the `JUPYTER_HOME` environment variable to the directory in which to store JupyterLab's configuration files. The default location is `~/.jupyter`.
 
 
 ## Provide your cloud service provider credentials to Docker
 
-You can use environment variables to pass your AWS or Azure credentials to Docker Compose.
-
-***What does doing this enable?***
-
 :::note 
 You can provide the credentials two ways:
 - Use a YAML file that contains environment varibles for storing your credentials.
 - Use a local volume containing your credentials. 
 
 See both methods in the **Jupyter and AI Unlimited** section of [Deploy with Docker Compose](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/docker/README.md) in the Teradata AI Unlimited GitHub repository.
 
-This QuickStart assumes you are using the first method.
+This QuickStart uses the first method.
 :::
 
 1. Copy these environment variables from your cloud service provider's console.
@@ -86,11 +79,13 @@ This QuickStart assumes you are using the first method.
 
 	The command downloads and starts the manager and JupyterLab containers.
 
-2. To retrieve the Jupyter token, list the currently running containers, and identify the name of the JupyterLab container.
+2. To retrieve the Jupyter token, list the currently running containers.
 
 	```bash
 	docker ps 
 	```
+	And identify the name of the JupyterLab container.
+
 	Then search for occurrences of the string 'Token' in the container's logs.
 
 	```bash

diff --git a/docs/advanced/quickstart/docker-when-you-are-done.md b/docs/advanced/quickstart/docker-when-you-are-done.md
@@ -28,6 +28,7 @@ docker-compose -f ai-unlimited.yaml -f azure-credentials-env-vars.yaml -f jupyte
 </TabItem>
 </Tabs> 
 
+***This next sentence needs verification and more context--so it jibes with the previous page. Is it about using a local volume to pass CSP credentials to Docker?***
+
 You can also remove any local directory or files, containing engine data, that you mounted to the Docker containers. 
 
-***Did we suggest they mount a directory/files? Not seeing it in the QuickStart.***
diff --git a/docs/explore-and-analyze-data/create-first-project.md b/docs/explore-and-analyze-data/create-first-project.md
@@ -197,7 +197,7 @@ Run `%help` or `%help <command>` for details on all magic commands or any one of
 	%project_backup project=<Project_Name>
 	```
 
-9. Suspend the engine.
+9. Suspend the engine to avoid incurring charges for unneeded engine resources.
     ```bash
     %project_engine_suspend project=<Project_Name>
     ```

diff --git a/docs/explore-and-analyze-data/index.md b/docs/explore-and-analyze-data/index.md
@@ -20,4 +20,8 @@ If you don't have JupyterLab or the AI Unlimited kernel, see [Jupyter installato
 - [Create your first project](/docs/explore-and-analyze-data/create-first-project.md)
 - See the overall [project flow](/docs/explore-and-analyze-data/project-flow.md)
 - Explore a collection of [example project notebooks](/docs/explore-and-analyze-data/example-projects.md)&mdash;and try them out
-- See the [magic commands](/docs/explore-and-analyze-data/magic-commands.md) the AI Unlimited Jupyter Kernel adds to your notebooks
+- See the [magic commands](/docs/explore-and-analyze-data/magic-commands.md) the AI Unlimited Jupyter Kernel adds to your notebooks
+
+:::tip
+To avoid incurring charges for unneeded engine resources, remember to [suspend](/docs/manage-ai-unlimited/suspend-resume-project.md) projects you're not working on.
+:::