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	`6e58bf0`
🔍 Latest deploy log	https://app.netlify.com/sites/replicated-docs/deploys/675214c8ed84760008771c43
😎 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	`6e58bf0`
🔍 Latest deploy log	https://app.netlify.com/sites/replicated-docs-upgrade/deploys/675214c8f9130600083a55b7
😎 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

    {
      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

        {
          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

            {
              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

                '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

docs/enterprise/delete-admin-console.md

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

+import FirewallOpenings from "../partials/install/_firewall-openings.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 GenerateBundle from "../partials/support-bundles/_generate-bundle.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 · 2024-12-02T20:26:22Z

sidebars.js

+        'enterprise/delete-admin-console',
+        {
+          type: 'category',
+          label: 'Using a GitOps Workflow (Deprecated)',


^ added "deprecated" label but I don't think that's accurate (yet?)

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

docs/enterprise/delete-admin-console.md Show resolved Hide resolved

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

paigecalvert marked this pull request as ready for review December 2, 2024 15:40

paigecalvert requested a review from a team as a code owner December 2, 2024 15:40

paigecalvert commented Dec 2, 2024

View reviewed changes

paigecalvert added 10 commits December 2, 2024 14:53

reorder

007e5aa

remove embedded k8s overview

8d2338b

updating xrefs

b62ad72

updating xrefs

053e218

editing xrefs to kots install overview page

c10e083

remove distributing overview topic and redirect

cfba2fe

removing embedded kurl language

9c29375

update xrefs

2014300

move kustomize topic

89b2b18

sidebar edit

6e58bf0

paigecalvert merged commit 709d72d into main Dec 5, 2024
5 checks passed

paigecalvert deleted the move-ec branch December 5, 2024 21:22


		## Firewall Openings for Online Installations

		<FirewallOpenings/> No newline at end of file


		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


		<ConfigValuesExample/>

		<ConfigValuesProcedure/>

Move EC to top level #2849

Move EC to top level #2849

Uh oh!

Conversation

paigecalvert commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for replicated-docs ready!

Uh oh!

netlify bot commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for replicated-docs-upgrade ready!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

paigecalvert Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

paigecalvert Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

paigecalvert Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

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