Move EC to top level #2849

paigecalvert · 2024-11-21T16:13:05Z

https://deploy-preview-2849--replicated-docs-upgrade.netlify.app/

Main changes:

Vendor Portal functionality/features nested under a new "Vendor Portal" section: https://deploy-preview-2849--replicated-docs-upgrade.netlify.app/vendor/vendor-portal-creating-account
Embedded Cluster tasks/concepts/reference nested under a new "Embedded Cluster" section: https://deploy-preview-2849--replicated-docs-upgrade.netlify.app/vendor/embedded-overview
^ Same for the kURL docs: https://deploy-preview-2849--replicated-docs-upgrade.netlify.app/vendor/kurl-about

netlify · 2024-11-21T16:13:20Z

✅ Deploy Preview for replicated-docs ready!

Name	Link
🔨 Latest commit	`b49e2f0`
🔍 Latest deploy log	https://app.netlify.com/sites/replicated-docs/deploys/67409583380626000800e456
😎 Deploy Preview	https://deploy-preview-2849--replicated-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2024-11-21T16:13:22Z

✅ Deploy Preview for replicated-docs-upgrade ready!

Name	Link
🔨 Latest commit	`b49e2f0`
🔍 Latest deploy log	https://app.netlify.com/sites/replicated-docs-upgrade/deploys/674095830a2a120008c3e00b
😎 Deploy Preview	https://deploy-preview-2849--replicated-docs-upgrade.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

paigecalvert · 2024-11-21T21:36:50Z

sidebars.js

@@ -111,91 +111,151 @@ const sidebars = {
    {type: 'html', value: '<h5>product docs</h5>', defaultStyle: true},
    {
      type: 'category',
-      label: 'Vendor Portal Teams and Accounts',
+      label: 'Vendor Portal',


Nest all the vendor portal features (like channels and releases, customers, teams and accounts, etc) under a Vendor Portal drop down

paigecalvert · 2024-11-21T21:37:40Z

sidebars.js

      ],
    },
    {
      type: 'category',
-      label: 'Channels and Releases',
+      label: 'Compatibility Matrix',


^ Figured we'd want this to be at its own level rather than nesting under VP

paigecalvert · 2024-11-21T21:38:34Z

sidebars.js

        {
          type: 'category',
-          label: 'Querying License Entitlements',
+          label: 'Installing with Embedded Cluster',


EC install docs are under Embedded Cluster section instead of under KOTS

paigecalvert · 2024-11-21T21:43:27Z

sidebars.js

      items: [
        'intro-kots',
        {
          type: 'category',
-          label: 'Packaging KOTS Releases',
+          label: 'Configuring KOTS',


Packaging KOTS Releases --> Configuring KOTS

"Configuring KOTS" seemed like it would be less loaded and more just directly explaining the contents of the topics in this section. "Packaging KOTS Releases" came about when the Vendor Portal have you the option to create a KOTS Release or Helm-Only Release

paigecalvert · 2024-11-21T21:44:02Z

sidebars.js

          items: [
            {
              type: 'category',
-              label: 'Distributing Helm Charts with KOTS',
+              label: 'Configuring the HelmChart Custom Resource',


^ Same here, these topics are just how to configure the HelmChart custom resource. "Distributing Helm Charts with KOTS" might imply that you are doing this for KOTS existing cluster installs specifically

paigecalvert · 2024-11-21T21:45:18Z

sidebars.js

              ],
            },
            {
                type: 'category',
-                label: 'Admin Console Config Screen',
+                label: 'Configuring the Admin Console Config Screen',


paigecalvert · 2024-11-21T21:47:11Z

sidebars.js

-              label: 'Exposing Services',
-              items: [
-                'vendor/admin-console-port-forward',
-                'vendor/kurl-nodeport-services',


'vendor/admin-console-port-forward',

Moved this to the Customizing the Admin Console section

'vendor/kurl-nodeport-services',

Moved this to the kURL section

paigecalvert · 2024-11-21T21:48:05Z

sidebars.js

@@ -311,232 +318,178 @@ const sidebars = {
                'vendor/packaging-ingress',
              ],
            },
+            'vendor/packaging-using-tls-certs',


Didn't have a great home for this one yet, but left it under KOTS. Follow up story to split this topic up because it contains both KOTS existing and kURL info

paigecalvert · 2024-11-21T21:48:37Z

sidebars.js

+            },
+            {
+              type: 'category',
+              label: 'Distributing Kubernetes Operators with KOTS',


^ Still need to do a story to split up this Kubernetes Operator info, but leaving it as is for the purpose of this PR

paigecalvert · 2024-11-21T21:48:56Z

sidebars.js

        {
          type: 'category',
-          label: 'Installing and Managing Applications',
+          label: 'Installing in Existing Clusters with KOTS',


^ Clarified that these topics are existing cluster install related only

paigecalvert · 2024-11-21T21:49:31Z

sidebars.js

+    },
+    {
+      type: 'category',
+      label: 'kURL',


kURL also gets it own top level section

Moved all the topics related to kurl that were under kots into this section

paigecalvert · 2024-11-21T21:50:11Z

sidebars.js

+            items: [
+              'vendor/support-bundle-generating',
+              'vendor/support-bundle-embedded',
+              'enterprise/troubleshooting-an-app',


'enterprise/troubleshooting-an-app',

This was previously in the kots section

paigecalvert · 2024-11-21T22:03:24Z

sidebars.js

+            items: [
+              'vendor/support-bundle-generating',
+              'vendor/support-bundle-embedded',
+              'enterprise/troubleshooting-an-app',


'enterprise/troubleshooting-an-app',

This (Generating a Support Bundle from the Admin Console) was previously in the kots section

paigecalvert · 2024-11-21T22:03:44Z

sidebars.js

+  },  
+  {
+    type: 'category',
+    label: 'Replicated Proxy Registry',


Proxy Registry gets a top level section

paigecalvert · 2024-11-21T22:04:55Z

sidebars.js

    ],
  },
  {
    type: 'category',
-    label: 'Integrating with CI/CD',
+    label: 'Helm Installations with Replicated',


Helm Install and CI/CD are the last two top level sections, and the only ones that aren't strictly related to a named product. Still don't love it, but I think better to focus on getting EC and kURL out from under KOTS then can revisit how these are organized

paigecalvert · 2024-11-21T22:06:31Z

sidebars.js

  // POLICIES
-  {type: 'html', value: '<h5>policies</h5>', defaultStyle: true},
+  {type: 'html', value: '<h5>platform overview</h5>', defaultStyle: true},


^ These go beyond Policies. Saw that Digital Ocean had named a similar section in their docs Platform Overview and liked it https://docs.digitalocean.com/platform/

paigecalvert · 2024-11-21T22:07:22Z

sidebars.js

+        href: 'https://www.replicated.com/security/'
+      },
+      'enterprise/sbom-validating',
+      'vendor/replicated-sdk-slsa-validating',


^ Moved both the existing security-related workflows here. SBOM had info for a few different installers and felt better to leave it as a single topic versus trying to split it up and divide amongst the sections

paigecalvert · 2024-11-21T22:08:04Z

sidebars.js

-            'vendor/licenses-reference-kots-runtime',
-            'vendor/licenses-verify-fields-sdk-api',
-          ]
+            'enterprise/installing-embedded-requirements',


'enterprise/installing-embedded-requirements',

Split out all the installation requirements into separate topics (One for existing, ec, and kurl)

paigecalvert · 2024-11-21T22:08:32Z

sidebars.js

+            'enterprise/installing-embedded-requirements',
+            'enterprise/installing-embedded',
+            'enterprise/installing-embedded-air-gap',
+            'enterprise/installing-embedded-automation',


^ split out all the procedures on how to install from the command line into their own topics (existing cluster, ec, and kurl)

paigecalvert · 2024-11-21T22:11:35Z

docs/enterprise/delete-admin-console.md

-This topic describes how to remove installed applications and delete the Replicated Admin Console from a cluster. See the following sections:
-* [Remove an Application](#remove-an-application)
-* [Delete the Admin Console](#delete-the-admin-console)
+This topic describes how to remove installed applications and delete the Replicated Admin Console from a cluster.


Removed this info about the kURL reset command and moved that to its own topic (could also just removed info about the reset command from the docs all together and point people to the kurl site for that).

Now, this topic is just for existing cluster KOTS

paigecalvert · 2024-11-21T22:12:02Z

docs/enterprise/installing-embedded-automation.mdx

+import ConfigValuesExample from "../partials/configValues/_configValuesExample.mdx"
+import ConfigValuesProcedure from "../partials/configValues/_config-values-procedure.mdx"
+
+# Installing with Embedded Cluster from the Command Line


EC gets its own install automation topic in its own section

In a follow up PR, could also consider making sure that each of the command line install topics are discoverable from the CI/CD section of the docs where people might need the info

paigecalvert · 2024-11-21T22:12:59Z

docs/enterprise/installing-embedded-automation.mdx

+
+<ConfigValuesExample/>
+
+<ConfigValuesProcedure/>


^ info about generating the configvalues file is added to a partial rather than being in its own topic. This solved the problem of trying to find a home for a topic that cut across three different installers

paigecalvert · 2024-11-21T22:14:12Z

docs/enterprise/installing-embedded-requirements.mdx

+
+## Firewall Openings for Online Installations
+
+<FirewallOpenings/>


^ note that I decided to just put the firewall openings for online installs in a partial for now. It appears in each of the installer requirements topics

paigecalvert · 2024-11-22T14:22:33Z

docs/enterprise/installing-embedded-requirements.mdx

+import EmbeddedClusterPortRequirements from "../partials/embedded-cluster/_port-reqs.mdx"
+import FirewallOpenings from "../partials/install/_firewall-openings.mdx"
+
+# Embedded Cluster Installation Requirements


New embedded cluster-specific installation requirements topic

paigecalvert · 2024-11-22T14:23:06Z

docs/enterprise/installing-general-requirements.mdx


-# Installation Requirements
+# KOTS Installation Requirements


Removed all the EC and kURL stuff and called this KOTS Install Reqs

paigecalvert · 2024-11-22T14:23:20Z

docs/enterprise/installing-kurl-automation.mdx

+import DownloadkURLBundle from "../partials/install/_download-kurl-bundle.mdx"
+import ExtractKurlBundle from "../partials/install/_extract-kurl-bundle.mdx"
+
+# Installing with kURL from the Command Line


kURL also gets its own command line install topic

paigecalvert · 2024-11-22T14:28:29Z

docs/vendor/releases-configvalues.md

-
-For more information about installing from the command line, see [Installing from the Command Line](/enterprise/installing-existing-cluster-automation).
-
-## Get the ConfigValues File


This procedure was moved to a partial to be used in each of the topics on installing from the command line

paigecalvert · 2024-11-22T14:29:32Z

docs/vendor/releases-configvalues.md

-             value: hello world
-       ```
-
-## Share a Sample ConfigValues File    


I didn't put this content anywhere else yet (ie, this would just get deleted). Not sure if people are using it, but if they are, this could go in a section in the Onboarding docs about "supporting CLI installs for your users" or something like that

paigecalvert · 2024-11-22T14:31:20Z

docs/vendor/kurl-reset.mdx

@@ -0,0 +1,29 @@
+# Reset a kURL Cluster


Moved this existing content out of a kots topic about deleting the admin console. Could also just remove this content all together rather than creating this new topic. Not sure if we really recommend the reset command for kurl anyway

paigecalvert · 2024-11-22T14:37:45Z

sidebars.js

      ],
    },
    {
      type: 'category',
-      label: 'Distributing and Installing with KOTS',
+      label: 'KOTS',


^ KOTS section = docs for things that are features of the KOTS product (snapshots, KOTS custom resources, KOTS template functions, Status Informers, etc). Additionally, the docs for how to install with KOTS in an existing cluster will also appear here.

paigecalvert · 2024-11-22T14:39:14Z

docs/enterprise/installing-overview.md

@@ -1,59 +1,41 @@
-# About Installing an Application
+# Considerations Before Installing


Some MVP edits to this topic to remove the info about "embedded" stuff

paigecalvert · 2024-11-22T14:39:45Z

docs/enterprise/troubleshooting-an-app.mdx

 import GenerateBundleAdminConsole from "../partials/support-bundles/_generate-bundle-admin-console.mdx"

+# Generating Support Bundles from the Admin Console


Updated so this is just Admin Console related to differentiate from the other existing topics on generating SBs

paigecalvert added 7 commits November 20, 2024 15:03

moving ec to top level

a273324

edits

c853bcd

Move EC to top level

738262b

divide automation topic

fd3ddb9

update kots install overview

11673ad

split up configvalues

c1d6735

split info about deleting kots

d679872

replicated-ci added type::docs Improvements or additions to documentation type::feature labels Nov 21, 2024

paigecalvert mentioned this pull request Nov 21, 2024

Update KOTS install overview #2835

Closed

paigecalvert added 5 commits November 21, 2024 09:19

fix partials

8a1309c

sidebar edits

d0975e2

edits

8d6ea33

remove configvalues topic

dc1563d

missing partial

49d22e5

paigecalvert force-pushed the move-ec branch from 6fe5fd9 to 49d22e5 Compare November 21, 2024 20:29

paigecalvert added 4 commits November 21, 2024 13:30

Merge branch 'main' into move-ec

325a101

fixing xrefs

b4b770d

fixing anchor links

96af7c7

fixing xrefs

f898277

paigecalvert commented Nov 21, 2024

View reviewed changes

sidebars.js

},

{

type: 'category',

label: 'Replicated Proxy Registry',

Copy link

Contributor Author

paigecalvert Nov 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proxy Registry gets a top level section

paigecalvert commented Nov 21, 2024

View reviewed changes

update topic title

a930a70

paigecalvert commented Nov 21, 2024

View reviewed changes

paigecalvert commented Nov 22, 2024

View reviewed changes

edit xrefs

2faac97

paigecalvert commented Nov 22, 2024

View reviewed changes

edit

b49e2f0

paigecalvert commented Nov 22, 2024

View reviewed changes


		## Firewall Openings for Online Installations

		<FirewallOpenings/>


		For more information about installing from the command line, see [Installing from the Command Line](/enterprise/installing-existing-cluster-automation).

		## Get the ConfigValues File

		@@ -1,59 +1,41 @@
		# About Installing an Application
		# Considerations Before Installing

		import GenerateBundleAdminConsole from "../partials/support-bundles/_generate-bundle-admin-console.mdx"

		# Generating Support Bundles from the Admin Console


		<ConfigValuesExample/>

		<ConfigValuesProcedure/>

Move EC to top level #2849

Are you sure you want to change the base?

Move EC to top level #2849

Conversation

paigecalvert commented Nov 21, 2024 • edited Loading

netlify bot commented Nov 21, 2024 • edited Loading

✅ Deploy Preview for replicated-docs ready!

netlify bot commented Nov 21, 2024 • edited Loading

✅ Deploy Preview for replicated-docs-upgrade ready!

Choose a reason for hiding this comment

paigecalvert Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paigecalvert Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paigecalvert Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paigecalvert commented Nov 21, 2024 •

edited

Loading

netlify bot commented Nov 21, 2024 •

edited

Loading

netlify bot commented Nov 21, 2024 •

edited

Loading

paigecalvert Nov 21, 2024 •

edited

Loading

paigecalvert Nov 21, 2024 •

edited

Loading

paigecalvert Nov 21, 2024 •

edited

Loading