WAIT FOR EC GA: Onboarding docs updates

docs/intro.md

@@ -43,66 +43,60 @@ pagination_next: null
         <p>Onboarding workflows, tutorials, and labs to help you get started with Replicated quickly.</p>
     </li>
     <li>
-      <a href="intro-replicated">Introduction to Replicated</a>
+      <a href="intro-replicated">Introduction to the Commercial Software Distribution Life Cycle</a>
     </li>
     <li>
-      <a href="/vendor/distributing-overview">About Distributing Applications with Replicated</a>
+      <a href="/vendor/quick-start-embedded">Embedded Cluster Quick Start</a>
     </li>
     <li>
-      <a href="/vendor/replicated-onboarding">Replicated Quick Start</a>
+      <a href="/vendor/quick-start-helm">Helm CLI-Only Quick Start</a>
     </li>
     <li>
-      <a href="/vendor/tutorial-kots-helm-setup">Tutorials</a>
+      <a href="/vendor/tutorial-kots-helm-setup">Getting Started Tutorials</a>
     </li>
     <li>
       <a href="https://play.instruqt.com/embed/replicated/tracks/distributing-with-replicated?token=em_VHOEfNnBgU3auAnN">Getting Started Lab in Instruqt</a>
     </li>
   </ul>
 </section>
 <section class="tile__container">
-<ul>
+  <ul>
     <li class="tile__header">
-        <img src="images/icons/vendor_portal_1.png" alt="vendor portal icon" width="55px" height="55px"></img>
-        <p>Vendor Platform</p>
+        <img src="images/icons/admin.png" alt="kots icon"></img>
+        <p>Replicated KOTS</p>
     </li>
     <li>
-        <p>Create and manage your account and team.</p>
+        <p>A kubectl plugin and in-cluster Admin Console that installs applications in customer-controlled environments.</p>
     </li>
     <li>
-      <a href="/vendor/vendor-portal-creating-account">Creating a Vendor Account</a>
+      <a href="intro-kots">Introduction to KOTS</a>
     </li>
     <li>
-      <a href="/vendor/team-management#invite-members">Managing Team Members</a>
+      <a href="/vendor/kots-faq">KOTS Terminology and FAQs</a>
     </li>
     <li>
-      <a href="/vendor/team-management-rbac-configuring">Configuring RBAC Policies</a>
+      <a href="/vendor/distributing-workflow">Onboarding with KOTS</a>
+    </li>
+    <li>
+      <a href="/vendor/helm-native-about">About Distributing Helm Charts with KOTS</a>
     </li>
   </ul>
   <ul>
     <li class="tile__header">
-        <img src="images/icons/release.png" alt="rocket ship icon" width="55px" height="55px"></img>
-        <p>Compatibility Matrix</p>
-    </li>
-    <li>
-        <p>Rapidly create Kubernetes clusters, including OpenShift.</p>
-    </li>
-    <li>
-      <a href="/vendor/testing-about">About Compatibility Matrix</a>
-    </li>
-    <li>
-      <a href="/vendor/testing-how-to">Using Compatibility Matrix</a>
+        <img src="images/icons/k8s_installer.png" alt="installer icon"></img>
+        <p>Embedded Cluster</p>
     </li>
     <li>
-      <a href="/vendor/testing-supported-clusters">Supported Cluster Types</a>
+        <p>Embed Kubernetes with your application to support installations on VMs or bare metal servers.</p>
     </li>
     <li>
-      <a href="/vendor/testing-cluster-addons">Cluster Add-ons</a>
+      <a href="/vendor/embedded-kubernetes-overview">About Embedded Kubernetes</a>
     </li>
     <li>
-      <a href="/vendor/ci-workflows">Recommended CI/CD Workflows</a>
+      <a href="/vendor/embedded-overview">Using Embedded Cluster (Beta)</a>
     </li>
   </ul>
-  </section>
+</section>
 <section class="tile__container">
   <ul>
     <li class="tile__header">
@@ -128,45 +122,48 @@ pagination_next: null
       <a href="/vendor/replicated-sdk-overview">About the Replicated SDK</a>
     </li>
   </ul>
-    </section>
+</section>
 <section class="tile__container">
-  <ul>
+<ul>
     <li class="tile__header">
-        <img src="images/icons/admin.png" alt="kots icon"></img>
-        <p>Replicated KOTS</p>
-    </li>
-    <li>
-        <p>A kubectl plugin and in-cluster Admin Console that installs applications in customer-controlled environments.</p>
+        <img src="images/icons/vendor_portal_1.png" alt="vendor portal icon" width="55px" height="55px"></img>
+        <p>Vendor Platform</p>
     </li>
     <li>
-      <a href="intro-kots">Introduction to KOTS</a>
+        <p>Create and manage your account and team.</p>
     </li>
     <li>
-      <a href="/vendor/kots-faq">KOTS Terminology and FAQs</a>
+      <a href="/vendor/vendor-portal-creating-account">Creating a Vendor Account</a>
     </li>
     <li>
-      <a href="/vendor/distributing-workflow">Onboarding with KOTS</a>
+      <a href="/vendor/team-management#invite-members">Managing Team Members</a>
     </li>
     <li>
-      <a href="/vendor/helm-native-about">About Distributing Helm Charts with KOTS</a>
+      <a href="/vendor/team-management-rbac-configuring">Configuring RBAC Policies</a>
     </li>
   </ul>
   <ul>
     <li class="tile__header">
-        <img src="images/icons/k8s_installer.png" alt="installer icon"></img>
-        <p>Embedded Kubernetes</p>
+        <img src="images/icons/release.png" alt="rocket ship icon" width="55px" height="55px"></img>
+        <p>Compatibility Matrix</p>
     </li>
     <li>
-        <p>Embed Kubernetes with your application to support installations on VMs or bare metal servers.</p>
+        <p>Rapidly create Kubernetes clusters.</p>
     </li>
     <li>
-      <a href="/vendor/embedded-kubernetes-overview">About Embedded Kubernetes</a>
+      <a href="/vendor/testing-about">About Compatibility Matrix</a>
     </li>
     <li>
-      <a href="/vendor/kurl-about">Introduction to kURL</a>
+      <a href="/vendor/testing-how-to">Using Compatibility Matrix</a>
     </li>
     <li>
-      <a href="/vendor/embedded-overview">Using Embedded Cluster (Beta)</a>
+      <a href="/vendor/testing-supported-clusters">Supported Cluster Types</a>
+    </li>
+    <li>
+      <a href="/vendor/testing-cluster-addons">Cluster Add-ons</a>
+    </li>
+    <li>
+      <a href="/vendor/ci-workflows">Recommended CI/CD Workflows</a>
     </li>
   </ul>
 </section>

docs/partials/embedded-cluster/_default-config.mdx

@@ -0,0 +1,7 @@
+```yaml
+apiVersion: embeddedcluster.replicated.com/v1beta1
+kind: Config
+spec:
+  version: 1.8.0+k8s-1.29
+```
+See the Embedded Cluster [GitHub repo](https://github.com/replicatedhq/embedded-cluster/releases) to find the latest version.

docs/partials/getting-started/_add-license-entitlements.mdx

@@ -0,0 +1,3 @@
+You can add custom license entitlements for your application in the Vendor Portal. Custom license fields are useful when there is entitlement information that applies to a subset of customers. For example, you can create a custom license field to limit the number of active users permitted. Or, you can create a field that limits the number of nodes a customer is permitted on their cluster.
+
+After you add custom entitlements, you can also add logic to your application to query license entitlements both before deployment and at runtime.

docs/partials/getting-started/_best-practices.mdx

@@ -0,0 +1,7 @@
+The following are some best practices and recommendations for successfully onboarding with Replicated:
+
+* When integrating new Replicated features with an application, make changes in small iterations and test frequently by installing or upgrading the application in a development environment. This will help you to more easily identify issues and troubleshoot.
+
+* Try creating and managing releases with both the Vendor Portal and the Replicated CLI. For more information, see [Installing the Replicated CLI](/reference/replicated-cli-installing).
+
+* Ask for help from the Replicated community. For more information, see [Get Help from the Community](#get-help-from-the-community).

docs/partials/getting-started/_ci-cd.mdx

@@ -0,0 +1,6 @@
+Replicated recommends that teams integrate the Replicated Platform into their existing develeopment and production CI/CD workflows. This can be useful for automating the processes of creating new releases, promoting releases, and testing releases with the Replicated Compatibility Matrix.
+
+For more information, see:
+* [About Integrating with CI/CD](/vendor/ci-overview)
+* [About Compatibility Matrix](/vendor/testing-about)
+* [Recommended CI/CD Workflows](/vendor/ci-workflows)

docs/partials/getting-started/_community.mdx

@@ -0,0 +1,5 @@
+The [Replicated community site](https://community.replicated.com/) is a forum where Replicated team members and users can post questions and answers related to working with the Replicated Platform. It is designed to help Replicated users troubleshoot and learn more about common tasks involved with distributing, installing, observing, and supporting their application. 
+
+Before posting in the community site, use the search to find existing knowledge base articles related to your question. If you are not able to find an existing article that addresses your question, create a new topic or add a reply to an existing topic so that a member of the Replicated community or team can respond.
+
+To search and participate in the Replicated community, see https://community.replicated.com/.

docs/partials/getting-started/_connect-image-registry.mdx

@@ -0,0 +1,3 @@
+Add credentials for your image registry to the Vendor Portal. This will allow you to enable the Replicated proxy service in a later step so that you can grant proxy access to application images without exposing registry credentials to your customers.
+
+For more information, see [Connecting to an External Registry](/vendor/packaging-private-images).

docs/partials/getting-started/_create-app.mdx

@@ -0,0 +1 @@
+Create an application in the Vendor Portal. See [Create an Application](/vendor/vendor-portal-manage-app#create-an-application).

docs/partials/getting-started/_custom-channels.mdx

@@ -0,0 +1,5 @@
+By default, the Vendor Portal includes Unstable, Beta, and Stable channels. You can customize the channels in the Vendor Portal based on your application needs.
+
+For more information, see:
+* [About Channels and Releases](releases-about-releases)
+* [Creating and Editing Channels](/vendor/releases-creating-channels)

docs/partials/getting-started/_custom-domains.mdx

@@ -0,0 +1,3 @@
+Replicated recommends that you use custom domains to alias Replicated endpoints. Replicated domains are external to your domain and can require additional security reviews by your customer. Using custom domains as aliases can bring the domains inside an existing security review and reduce your exposure.
+
+For more information, see [Using Custom Domains](/vendor/custom-domains-using).

docs/partials/getting-started/_custom-metrics.mdx

@@ -0,0 +1,3 @@
+In addition to the built-in insights displayed in the Vendor Portal by default (such as uptime and time to install), you can also configure custom metrics to measure instances of your application running customer environments. Custom metrics can be collected for application instances running in online or air gap environments using the Replicated SDK.
+
+For more information, see [Configuring Custom Metrics](/vendor/custom-metrics).

docs/partials/getting-started/_customize-support-bundles.mdx

@@ -0,0 +1,6 @@
+You can optionally customize the support bundle spec for your application by:
+
+* Adding collectors and analyzers
+* Editing or excluding the default `clusterInfo` and `clusterResources` collectors
+
+For more information, see [(Optional) Customize the Specification](/vendor/support-bundle-customizing#optional-customize-the-specification) in _Adding and Customizing Support Bundles_.

docs/partials/getting-started/_enable-proxy-service.mdx

@@ -0,0 +1,11 @@
+import HelmPackage from "../helm/_helm-package.mdx"
+
+1. Follow the steps in [Using the Proxy Service with Helm Installations](/vendor/helm-image-registry) to authenticate with the Replicated proxy service by creating a Secret with `type: kubernetes.io/dockerconfigjson` in your Helm chart.
+
+1. Update dependencies and package the chart as a `.tgz` file:
+
+    <HelmPackage/>
+
+1. Add the `.tgz` file to a release. For more information, see [Managing Releases with the Vendor Portal](releases-creating-releases) or [Managing Releases with the CLI](releases-creating-cli).
+
+1. Install the release with the Helm CLI to test your changes. For more information, see [Installing with Helm](/vendor/install-with-helm).

docs/partials/getting-started/_package-sdk.mdx

@@ -0,0 +1 @@
+In your application Helm chart `Chart.yaml` file, add the YAML below to declare the SDK as a dependency. If your application is installed as multiple charts, declare the SDK as a dependency of the chart that customers install first. Do not declare the SDK in more than one chart. For more information, see [Packaging a Helm Chart for a Release](helm-install-release).

docs/partials/getting-started/_preflights.mdx

@@ -0,0 +1,21 @@
+import HelmPackage from "../helm/_helm-package.mdx"
+
+:::note
+Before you begin this task, Replicated recommends that you complete the [Add Preflight Checks to a Helm Chart](/vendor/tutorial-preflight-helm-setup) tutorial to learn how to add a preflight spec to a Helm chart in a Kubernetes secret, then run the preflight checks before installation.
+:::
+
+To define preflight checks for your application:
+
+1. In your Helm chart `templates` directory, add a Kubernetes Secret that includes a preflight spec. For more information, see [Defining Preflight Checks](/vendor/preflight-defining).
+
+1. Update dependencies and package the chart as a `.tgz` file:
+
+   <HelmPackage/>
+
+1. Add the `.tgz` file to a new release. For more information, see [Managing Releases with the Vendor Portal](releases-creating-releases) or [Managing Releases with the CLI](releases-creating-cli).
+
+1. Install the release to test your changes.
+
+    Preflight checks run automatically during installation.
+
+1. Continue to create and test new releases with additional preflight checks until you are ready to move on to the next task.

docs/partials/getting-started/_prerequisites.mdx

@@ -0,0 +1,5 @@
+* Create an account in the Vendor Portal. You can either create a new team or join an existing team. For more information, see [Creating a Vendor Account](vendor-portal-creating-account).
+
+* Install the Replicated CLI. See [Installing the Replicated CLI](/reference/replicated-cli-installing).
+
+* Complete a basic quick start workflow to create an application with a sample Helm chart and then promote and install releases in a development environment. This helps you get familiar with the process of creating, installing, and updating releases in the Replicated Platform. See [KOTS and Embedded Cluster Quick Start](/vendor/quick-start-embedded) or [Helm CLI-Only Quick Start](quick-start-helm).

docs/partials/getting-started/_quick-start-intro.mdx

@@ -0,0 +1 @@
+This workflow shows how to create, install, and update releases for a sample Helm chart in the Replicated Platform. You will repeat these same basic steps to create and test releases throughout the onboarding process to integrate Replicated features with your own application.

docs/partials/getting-started/_quick-start-next-steps.mdx

@@ -0,0 +1 @@
+Now that you are familiar with the workflow of creating, installing, and updating releases, you can begin onboarding your own application to the Replicated Platform.

docs/partials/getting-started/_quick-start-objectives.mdx

@@ -0,0 +1,7 @@
+The goals of this quick start are to introduce new Replicated users to the following common tasks for the purpose of preparing to onboard to the Replicated Platform:
+
+* Working with _applications_, _channels_, _releases_, and _customers_ in the Replicated Vendor Portal
+
+* Working with the Replicated CLI
+
+* Working with the KOTS Admin Console

docs/partials/getting-started/_quick-start-welcome.mdx

@@ -0,0 +1 @@
+Welcome! This topic provides a quick start workflow to help new users learn about the Replicated Platform. Complete this quick start before you onboard your application to the platform.

docs/partials/getting-started/_setup-cluster.mdx

@@ -0,0 +1 @@
+Ensure that you have kubectl access to a Kubernetes cluster. You can use any cloud provider or tool that you prefer to create a cluster, such as [Replicated Compatibility Matrix](/vendor/testing-how-to), Google Kubernetes Engine (GKE), or minikube.

docs/partials/getting-started/_support-bundles.mdx

@@ -0,0 +1,36 @@
+import HelmPackage from "../helm/_helm-package.mdx"
+import TestYourChanges from "../getting-started/_test-your-changes.mdx"
+
+To add the default support bundle spec to your application:
+
+1. In your Helm chart `templates` directory, add the following YAML a Kubernetes Secret:
+
+    ```yaml
+    apiVersion: v1
+    kind: Secret
+    metadata:
+      labels:
+        troubleshoot.sh/kind: support-bundle
+      name: example
+    stringData:
+      support-bundle-spec: |
+        apiVersion: troubleshoot.sh/v1beta2
+        kind: SupportBundle
+        metadata:
+          name: support-bundle
+        spec:
+          collectors: []
+          analyzers: []
+    ```
+
+   For more information, see <a href="/vendor/support-bundle-customizing">Adding and Customizing Support Bundles</a>.
+
+1. Update dependencies and package the chart as a `.tgz` file:
+
+   <HelmPackage/>
+
+1. Add the `.tgz` file to a new release. For more information, see [Managing Releases with the Vendor Portal](releases-creating-releases) or [Managing Releases with the CLI](releases-creating-cli).
+
+1. Install the release to test your changes. For information about how to create support bundles, see [Generating Support Bundles](/vendor/support-bundle-generating).
+
+1. (Optional) Customize the support bundle spec by adding additional collectors and analyzers. You can do this step later. See [(Optional) Customize the Specification](/vendor/support-bundle-customizing#optional-customize-the-specification) in _Adding and Customizing Support Bundles_.

docs/partials/getting-started/_test-your-changes.mdx

@@ -0,0 +1 @@
+Install the release to test your changes. See [Performing Udpates in Embedded Clusters](/enterprise/updating-embedded) and [Performing Updates in Existing Clusters](/enterprise/updating-app-manager).

docs/partials/preflights/_overview.mdx

@@ -0,0 +1,5 @@
+Preflight checks and support bundles are provided by the Troubleshoot open source project, which is maintained by Replicated. Troubleshoot is a kubectl plugin that provides diagnostic tools for Kubernetes applications. For more information, see the open source [Troubleshoot](https://troubleshoot.sh/docs/collect/) documentation.
+
+Preflight checks and support bundles analyze data from customer environments to provide insights that help users to avoid or troubleshoot common issues with an application:
+* **Preflight checks** run before an application is installed to check that the customer environment meets the application requirements.
+* **Support bundles** collect troubleshooting data from customer environments to help users diagnose problems with application deployments.