setup, new ui - improved graphic (needs more tweaks)

Teradata · Apr 27, 2024 · 8844064 · 8844064
1 parent 95a83ad
commit 8844064
Show file tree

Hide file tree

Showing 8 changed files with 1,027 additions and 31 deletions.
diff --git a/docs/_partials/_create-oauth-app.mdx b/docs/_partials/_create-oauth-app.mdx
diff --git a/docs/advanced/aws-persistent-storage.md b/docs/advanced/aws-persistent-storage.md
@@ -13,7 +13,7 @@ tags:
 
 # Persistent volumes on AWS
 
-***WIP***
+***WIP - and will probably move this***
 
 With AI Unlimited, you can redeploy your engine for which the state needs to be persisted regardless of container, pod, or node crashes or terminations. This feature requires persistent storage, that is, storage that lives beyond the lifetime of the container, pod, or node. AI Unlimited uses the instance root volume of the instance to save data in the JupyterLab **/userdata** folder, AI Unlimited database, and configuration files. The data persists if you shut down, restart, or snapshot and relaunch the instance. However, if the instance is terminated, your JupyterLab data and AI Unlimited database are lost, and this could pose problems if running on-the-spot instances, which may be removed without warning. If you want a highly persistent instance, enable the `UsePersistentVolume` parameter to move the JupyterLab data and AI Unlimited database to a separate volume.
 

diff --git a/docs/advanced/git-requirements.md b/docs/advanced/git-requirements.md
@@ -26,7 +26,13 @@ The `deployments` folder in the [AI Unlimited GitHub repository](https://github.
 
 ## Create a GitHub or GitLab OAuth app
 
-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.
+An OAuth app allows a user to grant access to their account on one website or service to their account on another, without sharing their password.
+
+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. 
+
+:::note
+AI Unlimited creates this repository when you install the AI Unlimited manager. ***READ Jack's slack response to my Q***
+:::
 
 1. Sign in to your GitHub or GitLab account. 
 

diff --git a/docs/explore-and-analyze-data/project-flow.md b/docs/explore-and-analyze-data/project-flow.md
@@ -19,9 +19,9 @@ AI Unlimited provides [magic commands](/docs/explore-and-analyze-data/magic-comm
 
 ## Project owners
 
-***placeholder graphic - to be replaced***
+***temporary graphic - being worked***
 
-import ProjectFlowImg from './project-flow_project-owner.svg';
+import ProjectFlowImg from './v-2_project-flow_project-owner.svg';
 
 <ProjectFlowImg />
 

diff --git a/docs/explore-and-analyze-data/v-2_project-flow_project-owner.svg b/docs/explore-and-analyze-data/v-2_project-flow_project-owner.svg
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
@@ -0,0 +1,94 @@
+---
+id: setup
+title: Help with post-installation setup
+description: Find additional information about some of the setup fields.
+sidebar_label: Set up AI Unlimited (test - new ui)
+sidebar_position: 4
+pagination_prev: null
+pagination_next: null
+---
+
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+
+# Set up AI Unlimited (test - new UI)
+
+After you install the manager, access it using the url provided at the end of the installation process.
+
+Sign in with your GitHub or GitLab credentials, then complete the setup. ***re-watch recording***
+
+To learn more about certain fields, click a section below. 
+
+***Need to figure out how to marry "manager" with just "AI Unlimited". Possible for "manager" to be used only in installation content and after that, from setup onward, it's just "AI Unlimited"? Make it so.***
+
+<details>
+
+<summary>Step 1: The basics</summary>
+
+**TLS**
+
+Use [Transport Layer Security (TLS)](/docs/glossary.md#glo-tls) to secure connections to the AI Unlimited service and safeguard your data in transit.
+
+
+**Certificates**
+
+If you have a certificate issued by a trusted Certificate Authority (CA), you can provide it and its key. You'll be responsible for managing the certificate lifecycle, including renewal and validation. If you have specific requirements or need more control over your certificates, bringing your own is a good option.
+
+Or use a Teradata system-generated certificate. It automatically renews before it expires.
+
+</details>
+
+
+<details>
+
+<summary>Step 2: Git integration</summary>
+
+**OAuth app**
+
+An OAuth app allows a user to grant access to their account on one website or service to their account on another, without sharing their password. 
+
+AI Unlimited uses your [OAuth app](/docs/advanced/git-requirements#oauth.md) to authorize access to your GitHub or GitLab account. This allows AI Unlimited to store user and project information there. 
+
+Selecting **Authenticate** establishes the access and returns you to the setup. ***add something about how all users will be authenticated***
+
+**Group access**
+
+Something about Groups in general--tie group concept to repository concept and authorization (not authentication?) concept.
+
+</details>
+
+
+<details>
+
+<summary>Step 3: Cloud integration</summary>
+
+<Tabs>
+<TabItem value="aws1" label="AWS">
+
+**IAM role**
+
+If AI Unlimited creates the [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html), it creates it for the AWS [cluster](/docs/glossary.md#glo-cluster) that deploys the engine&mdash;each time you deploy the engine. If your organization creates the role, it must be broad enough to include all the clusters that might deploy the engine. ***come back to this - in the doc, find the policy to which the UI refers ("create an IAM role using this policy")***
+
+***Inbound security - Permission boundaries is new***
+
+**Network type**
+
+Public or Private refers to how AI Unlimited should communicate with the engine. The engine might have a public IP address, a private IP address, or both. Indicate the type of IP address to which AI Unlimited should connect. ***Is it determined by a cloud parm? Tell them where/when they chose it and where to see it?***
+
+</TabItem>
+
+<TabItem value="azure" label="Azure">
+
+**Network type**
+
+Public or private refers to how AI Unlimited should communicate with the engine. The engine might have a public IP address, a private IP address, or both. Indicate the type of IP address to which AI Unlimited should connect. ***Is it determined by a cloud parm? Tell them where/when they chose it and where to see it?***
+
+</TabItem>
+</Tabs>
+
+</details>
+
+
+
diff --git a/docs/temp-folder/AWS-temp/prod-aws-prerequisites.md b/docs/temp-folder/AWS-temp/prod-aws-prerequisites.md
@@ -78,9 +78,7 @@ Use these JSON samples to create the policies you need, and attach them to the r
 
 ## Create a GitHub or GitLab OAuth app
 
-import MyPartial from '/docs/_partials/_create-oauth-app.mdx';
-
-<MyPartial />
+[removed the partial]
 
 
 ## Get deployment details

diff --git a/docs/temp-folder/Azure-temp/prod-azure-prerequisites.md b/docs/temp-folder/Azure-temp/prod-azure-prerequisites.md
@@ -80,10 +80,7 @@ The **Output** tab shows the network names and `RoleDefinitionId`. You'll need t
 
 ## Create a GitHub or GitLab OAuth app
 
-import MyPartial from '/docs/_partials/_create-oauth-app.mdx';
-
-<MyPartial />
-
+[removed the partial]
 
 ## Get deployment details