Merge branch 'add-developers-homepage' into feat/add-developers-homepage

docs/explore-and-analyze-data/collaborate-project.md

@@ -51,40 +51,42 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command
     %project_engine_list project=<Project_Name>
     ```
 
-4. If the engine is not deployed, deploy it.
-    <Tabs>
-    <TabItem value="aws1" label="AWS">
-
-    ```bash 
-    %project_engine_deploy project=<Project_Name>, size=<Size_of_Engine>, node=<Number_of_Nodes>, subnet=<Subnet_id>, region=<Region>, restore=<true|false>, prefixlist=<Prefix_List>, securitygroups=<Security_Group>, cidrs=<CIDR>, tags=<Tags>, iamrole=<IAM_Role>, roleprefix=<Role_Prefix>, permissionboundary=<Permission_Boundary>
-    ```
-
-    </TabItem>
-    <TabItem value="azure" label="Azure">
-
-    ```bash 
-    %project_engine_deploy project=<Project_Name>, size=<Size_of_Engine>, node=<Number_of_Nodes>, subnet=<Subnet_id>, region=<Region>, restore=<true|false>, network=<Network>, keyvault=<Key_Vault>, keyvaultresourcegroup=<Key_Vault_Resource_Group>, networkresourcegroup=<Network_Resource_Group>
-    ```
-    </TabItem>
-    </Tabs>
-
-	If you don't specify the number of nodes, one node is deployed.
-
+4. If the engine is not deployed, deploy it and restore the project. 
+
+   The size can be small, medium, large, or extralarge. The default is small. If you don't specify the number of nodes, one node is deployed. The default for restore is true.
+   
+   <Tabs>
+   <TabItem value="aws1" label="AWS">
+
+   ```bash 
+   %project_engine_deploy project=<Project_Name>, size=<Size_of_Engine>, node=<Number_of_Nodes>, subnet=<Subnet_id>, region=<Region>, restore=<true|false>, prefixlist=<Prefix_List>, securitygroups=<Security_Group>, cidrs=<CIDR>, tags=<Tags>, iamrole=<IAM_Role>, roleprefix=<Role_Prefix>, permissionboundary=<Permission_Boundary>
+   ```
+
+   </TabItem>
+   <TabItem value="azure" label="Azure">
+
+   ```bash 
+   %project_engine_deploy project=<Project_Name>, size=<Size_of_Engine>, node=<Number_of_Nodes>, subnet=<Subnet_id>, region=<Region>, restore=<true|false>, network=<Network>, keyvault=<Key_Vault>, keyvaultresourcegroup=<Key_Vault_Resource_Group>, networkresourcegroup=<Network_Resource_Group>
+   ```
+   </TabItem>
+   </Tabs>
+	
 5. Get your password for the engine.
-    ```bash
-    %project_user_list project=<Project_Name>
-    ```
+   ```bash
+   %project_user_list project=<Project_Name>
+   ```
 
 6. Refresh the connection to include your notebook.
-    ```bash 
-    %project_connection_add project=<Project_Name>
-    ```
-
-7. Connect to the project, and provide your password.
-    ```bash
-    %connect <Project_Name>
-    ```
-
+   ```bash 
+   %project_connection_add project=<Project_Name>
+   ```
+
+7. Connect to the project.
+   ```bash
+   %connect <Project_Name>
+   ```
+   When the connection is made, provide your password.
+   
 You're all set! Now you can contribute to the project.
 
 

docs/explore-and-analyze-data/create-first-project.md

@@ -47,7 +47,7 @@ For your first project, using data we provide, you'll complete this simple workf
 
 - From your profile, [get your API key](/docs/explore-and-analyze-data/get-api-key.md).
 
-- To run the sample workload, you'll need the `salescenter.csv` file. Download the file from the [AI Unlimited GitHub repository](https://github.com/Teradata/ai-unlimited/tree/develop/examples/GetStarted/data), and upload it to your Amazon Simple Storage Service (S3) or Azure Blob Storage location. If you're using your own file, modify the example accordingly.
+- To run the sample workload, you'll need the `salescenter.csv` file. Download the file from the [AI Unlimited GitHub repository](https://github.com/Teradata/ai-unlimited/tree/develop/examples/GetStarted/data), and upload it to your Amazon Simple Storage Service (S3) or Azure Blob Storage location. Or if you're using your own file, modify the example accordingly.
 
 
 ## Connect, and run your first workload
@@ -80,7 +80,7 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command
 
 5. Deploy the engine.
 
-    Replace `Project_Name`. The size can be small, medium, large, or extralarge. The default is small.
+    The size can be small, medium, large, or extralarge. The default is small.
     ```bash
     %project_engine_deploy name=<Project_Name>, size=<Size_of_Engine>
     ```
@@ -168,14 +168,16 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command
     DROP TABLE SalesDemo;
     ```
 
-8. Back up your project metadata and object definitions in your Git repository.
+8. Back up your project metadata and object definitions (the schema) in your Git repository.
 	```bash
 	%project_backup project=<Project_Name>
 	```
-
+   This backs up your project, but it does not suspend the engine.
+
 9. Suspend the engine to avoid paying for unneeded engine resources.
     ```bash
     %project_engine_suspend project=<Project_Name>
     ```
+   This backs up your project and suspends the engine. Typically you will not use `%project_backup` immediately followed by `%project_engine_suspend`.
 
 Congratulations! You've run your first workload.

docs/explore-and-analyze-data/example-projects.md

@@ -17,13 +17,20 @@ Discuss these and share ideas for other use cases in the [community](https://sup
 :::
 
 
+## Before you begin 
+
+- Use the **Before you begin** notebook to prepare your project.
+
+- Use your existing AWS Glue catalog and upload our [sample data](https://github.com/Teradata/ai-unlimited-demos/tree/main/UseCases/Data). Or create a new catalog to use the provided Open Table Format (OTF) examples.
+
+
 ## Understand the customer journey
 
 Customers engage with financial institutions through various marketing touchpoints including websites, in-branch interactions with employees, email, and call centers. 
 
 Understanding the overall customer journey is critical for enhancing it and increasing customer acquisition and adoption.
 
-For this use case, we provide data from customer interactions in an AWS Glue catalog in Iceberg format. After you access and inspect the data, you'll use attribution modeling, channel analysis, and pathing to understand the customer behavior over time.
+After you access and inspect the data, you'll use attribution modeling, channel analysis, and pathing to understand the customer behavior over time.
 
 [Try it out](https://github.com/Teradata/ai-unlimited-demos/blob/main/UseCases/Financial_Customer_Journey_SQL.ipynb) (SQL)
 
@@ -34,7 +41,7 @@ For this use case, we provide data from customer interactions in an AWS Glue cat
 
 Purchase history can be a powerful factor for segmenting customers. For instance, you might create segments based on purchase volume and value.
 
-For this use case, we provide online purchase history data in an AWS Glue catalog in Iceberg format. After you prepare the data, you'll use k-means clustering and data preparation pipelines to determine customer segments.
+After you prepare the data, you'll use k-means clustering and data preparation pipelines to determine customer segments.
 
 [Try it out](https://github.com/Teradata/ai-unlimited-demos/blob/main/UseCases/Native_Data_Prep_Transformation_Pipelines-SQL.ipynb) (SQL)
 
@@ -45,7 +52,7 @@ For this use case, we provide online purchase history data in an AWS Glue catalo
 
 Marketing to the ideal number of customer segments means you benefit from segmentation without having too many segments to manage. You can derive the ideal number of segments from comments from customer purchase history.
 
-For this use case, we provide customer comment data in an AWS Glue catalog in Iceberg format. After you access and inspect the data, you'll use a large language model (LLM) to create a vector table, and then find the ideal k-means model and number of segments.
+After you access and inspect the data, you'll use a large language model (LLM) to create a vector table, and then find the ideal k-means model and number of segments.
 
 [Try it out](https://github.com/Teradata/ai-unlimited-demos/blob/main/UseCases/Segmentation_With_Vector_Embedding-SQL.ipynb) (SQL)
 

docs/explore-and-analyze-data/get-api-key.md

@@ -18,7 +18,7 @@ Your API key, available from your user profile in the manager, stays the same fo
 :::note
 Your AI Unlimited admin is the person at your organization who set up AI Unlimited.
 :::
-2. Sign in to GitHub or GitLab.
+2. Sign in to GitHub or GitLab, and authenticate yourself.
 3. After being routed back to the manager, on your **Profile**, copy your API key.
 
 Keep your API key. Or go back to your **Profile** anytime to get it.

docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md

@@ -1,6 +1,6 @@
 ---
 id: deploy-manager-aws-console
-title: Deploy the manager using the AWS Management Console
+title: Install on AWS
 description: Learn how to deploy the manager using a CloudFormation template.
 sidebar_label: Install on AWS
 sidebar_position: 1
@@ -47,7 +47,7 @@ You might want to ask a cloud admin at your organization for guidance.
 
 1. Sign in to the [AWS console](https://aws.amazon.com).<br />
    :::note
-   References to the AWS Console are accurate as of April 11, 2024.
+   References to AWS Management Console elements are up-to-date as of May 29, 2024.
    ::: 
 2. Select the AWS region in which to deploy AI Unlimited.<br />
 We recommend selecting the region closest to your primary work location.
@@ -97,7 +97,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 section. |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 new or existing persistent volume to store data. See *Learn more: Using a persistent volume* below the parameters section. |Optional with default<br/>Default: New<br/>Supported options are a new persistent volume or an existing one, 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: 20<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: Retain <br/>Supported options are: Delete, Retain, RetainExceptOnCreate, and Snapshot.|
@@ -125,7 +125,7 @@ The concurrency will increase when AI Unlimited is released for general availabi
 
 <details>
 
-<summary>Learn more: Why use a persistent volume?</summary>
+<summary>Learn more: Using a persistent volume</summary>
 
 The manager instance runs in a container and saves its configuration data in a database in the root volume of the instance. This data persists if you shut down, restart, or snapshot and relaunch the instance. 
 
@@ -168,7 +168,7 @@ If the container, pod, or node crashes or terminates, and the manager's configur
 1. Review the template settings. 
 2. Select the check box to acknowledge that the template will create IAM resources. 
 3. Select **Submit** to deploy the stack.<br />
-On the **Events** tab, you can monitor progress. When the **Status** is `CREATE_COMPLETE`, the manager is ready. 
+On the **Events** tab, you can monitor progress. When the status of all the resources is `CREATE_COMPLETE`, the manager is ready. 
 
 The **Outputs** tab shows the values generated for the created resources.
 
@@ -177,7 +177,7 @@ You'll need the URL to access the manager and set up AI Unlimited.
 
 ## What's next
 
-[Create an OAuth app](/docs/resources/create-oauth-app) to allow authorization between AI Unlimited and your Git provider account.
+[Create an OAuth app](/docs/resources/create-oauth-app) to allow authentication between AI Unlimited and your Git provider account.
 
 
 

docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md

@@ -1,6 +1,6 @@
 ---
 id: deploy-manager-azure-portal
-title: Deploy the manager using the Azure Portal
+title: Install on Azure
 description: Learn how to deploy the manager using an Azure Resource Manager (ARM) template.
 sidebar_label: Install on Azure
 sidebar_position: 2
@@ -47,9 +47,9 @@ You might want to ask a cloud admin at your organization for guidance.
 
 1. Sign in to the [Azure Portal](https://portal.azure.com). 
    :::note
-   References to the Azure Portal are accurate as of April 14, 2024.
+   References to Azure Portal elements are up-to-date as of May 29, 2024.
    ::: 
-2. Select **Deploy a custom template**.
+2. Search for **custom deployment**, then select **Deploy a custom template**.
 3. Select **Build your own template in the editor**, then **Load file**.
 4. Select the template file you chose to use, then select **Save**.
 
@@ -83,7 +83,7 @@ Review the parameters. Provide values for the required parameters. Your organiza
 | Role Definition ID | The ID of the role to use with AI Unlimited.| Required<br/>Default: NA<br/>Use Azure CLI command- Get-AzRoleDefinition to get your Role Definition ID. |
 | Allow Public SSH | Specifies whether you can use secure shell (SSH) keys to connect to VMs in Azure.|  Optional<br/>Default: true |
 | Use Key Vault | Specifies whether to use Key Vault to retrieve the secured password during a deployment. | Optional<br/>Default: New |
-| Use Persistent Volume | 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: New <br/>Supported options: New, None, Existing, depending on your use case. |
+| Use Persistent Volume | Specifies whether you want to use a new or existing persistent volume to store data. See *Learn more: Using a persistent volume* below the parameters section. | Optional with default<br/>Default: New <br/>Supported options: New or Existing, depending on your use case. |
 | Persistent Volume Size | The size of the persistent volume that you can attach to the instance, in GB. | Optional<br/>Default: 100 |
 | Existing Persistent Volume | <br/>The ID of the existing persistent volume that you can attach to the instance.| Required if UsePersistentVolume is set to Existing.<br/>Default: None<br/>The persistent volume must be in the same availability zone as the AI Unlimited instance. |
 | AI Unlimited Version | The version of the AI Unlimited you want to deploy. | Required with default<br/>Default: latest<br/>The value is a container version tag. |
@@ -94,7 +94,7 @@ Review the parameters. Provide values for the required parameters. Your organiza
 
 <details>
 
-<summary>Learn more: Why use a persistent volume?</summary>
+<summary>Learn more: Using a persistent volume</summary>
 
 The manager instance runs in a container and saves its configuration data in a database in the root volume of the instance. This data persists if you shut down, restart, or snapshot and relaunch the instance. 
 
@@ -135,4 +135,4 @@ You'll need the URL to access the manager and set up AI Unlimited.
 
 ## What's next
 
-[Create an OAuth app](/docs/resources/create-oauth-app) to allow authorization between AI Unlimited and your Git provider account.
+[Create an OAuth app](/docs/resources/create-oauth-app) to allow authentication between AI Unlimited and your Git provider account.

docs/install-ai-unlimited/setup-ai-unlimited.md

@@ -124,7 +124,7 @@ Use these fields to allow source traffic to reach the engine:
 
 - **Default [CIDRs](/docs/glossary.md#classless-inter-domain-routing)**
 
-- **Default [application security group](https://learn.microsoft.com/en-us/azure/virtual-network/application-security-groups) names**— If you deploy the engine in the same Virtual Private Cloud as AI Unlimited, include the AI Unlimited application security group in this field to ensure that AI Unlimited can communicate with the engine.
+- **Default [security group](https://learn.microsoft.com/en-us/azure/virtual-network/application-security-groups) names**— If you deploy the engine in the same Virtual Private Cloud as AI Unlimited, include the AI Unlimited application security group in this field to ensure that AI Unlimited can communicate with the engine.
 
 **Resource tags**—You can [tag](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources) the Azure resources that deploy the engine to make them easier to manage.
 
@@ -162,15 +162,15 @@ Two organizations in your GitHub account can help with access control and reposi
 
 Select **Update**.
 
-Select **Sign In**. Then, if prompted, sign in.
+Select **Sign In**. Then, sign in (if prompted), and authenticate yourself.
 
 </TabItem>
 
 <TabItem value="gitlab" label="GitLab">
 
 <br />
 
-**GitLab callback URL**&mdash;After authenticating a user, GitLab uses this URL to redirect back to the manager. This was provided to the OAuth app [when it was created](docs/resources/create-oauth-app.md).
+**GitLab callback URL**&mdash;After authenticating a user, GitLab uses this URL to redirect to the manager. This was provided to the OAuth app [when it was created](docs/resources/create-oauth-app.md).
 
 **GitLab base URL**&mdash;The URL for your GitLab instance.
 
@@ -186,7 +186,7 @@ Two groups in your GitLab account can help with access control and repository ma
 
 Select **Update**.
 
-Select **Sign In**. Then, if prompted, sign in.
+Select **Sign In**. Then, sign in (if prompted), and authenticate yourself.
 
 </TabItem>
 </Tabs>

docs/manage-ai-unlimited/index.md

@@ -18,7 +18,7 @@ For help with managing projects, ask the [community](https://support.teradata.co
 
 - Use [magic commands](/docs/explore-and-analyze-data/magic-commands.md) to manage projects in Jupyter notebooks 
 
-- [Suspend and restore projects](/docs/manage-ai-unlimited/suspend-and-restore-project.md) to pay-as-you-go
+- [Suspend and restore projects](/docs/manage-ai-unlimited/suspend-and-restore-project.md) to pay as you go
 
 
 ## Project owners

docs/resources/aws-requirements.md

@@ -10,14 +10,16 @@ pagination_next: null
 
 # AWS account requirements
 
-Before you install AI Unlimited, address these items.
+First, make sure you have the [prerequisites](../install-ai-unlimited/index.md#prerequisites). 
+
+Then before you install AI Unlimited, address these AWS items.
 
 
 ## Prepare your AWS account
 
 - Work with your cloud admin to ensure you have the [IAM](https://aws.amazon.com/iam/) permissions to create the cloud resources defined in the [AI Unlimited template](https://github.com/Teradata/ai-unlimited/tree/develop/deployments/aws/templates/ai-unlimited).
 
-- If you need to access the manager instance to run commands or debug, you can connect to it one of these ways:
+- If you'll need to access the manager instance to run commands or debug, you can connect to it one of these ways:
 	- Use a [key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) to securely connect using Secure Shell (SSH). You will need the key pair when you [specify the stack details](/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md#specify-stack-details-and-options).
 	- Use AWS Session Manager to connect. To enable this, attach the [session-manager.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/session-manager.json) policy to a [role you provide](#provide-roles-created-by-your-organization) to the manager.
 
@@ -59,13 +61,13 @@ If your security does not allow AI Unlimited to create roles, provide roles crea
 
 The `deployments` folder in the [AI Unlimited GitHub repository](https://github.com/Teradata/ai-unlimited) provided by Teradata includes policy samples for the manager and engine roles.
 
-	Open a terminal window, and clone the repository.
+Open a terminal window, and clone the repository.
 
-    ``` bash
-    git clone https://github.com/Teradata/ai-unlimited
+``` bash
+git clone https://github.com/Teradata/ai-unlimited
 	```
 
-Or use the links that follow to download what you need.
+Or use the links provided in sections that follow to download what you need.
 
 
 ### Role for the manager