Swap gerunds for present tense verbs and add link-updating script

.cursor/rules/docs-style-guide.mdc

@@ -0,0 +1,62 @@
+---
+description: 
+globs: 
+alwaysApply: true
+---
+# Replicated Documentation Style Guide
+
+## Overview
+
+This set of rules provides guidelines for writing clear and consistent product documentation for the Replicated Platform.
+
+## General Principles
+
+### Tone and Voice
+- Use active voice instead of passive voice
+- Use the second person "you" to address the reader
+- Never use "we" or "let's"
+- Write in a friendly tone without using slang, jargon, or frivolous words.
+
+### Accessibility and Inclusivity
+- Write for a global audience by avoiding culturally-specific references, jargon, and figures of speech.
+- In HTML, use semantic tagging.
+- Avoid unnecessary font formatting.
+- Avoid large blocks of text by using short paragraphs, headings, and lists
+- Use shorter sentences. Try to use fewer than 26 words per sentence.
+
+### Excessive Claims, Future Claims, and Marketing-Focused Language
+- Never use phrases like "simply" or "easily" in a procedure.
+- Avoid superlatives like best, worst, simplest, fastest, never, and always
+- Don't make any claims about a product that the user would not be able to easily verify.
+
+### Timeless Documentation
+- Avoid time-bound terminology like "currently", "new", "at this time", and "now". Instead, write timeless documentation that makes no assumptions about a reader's prior knowledge.
+
+## Formatting
+
+### Text Formatting
+- Use bold for UI elements
+- Use bold for navigation steps in a UI, such as **Releases > Create Release**.
+- Use italics to draw attention to a word or phrase, such as when defining the term for the first time
+
+### Capitalization
+- Use title case for titles and headings
+- Use all caps with underscores between words for placeholder text
+- Avoid all caps outside of placeholder text and code examples
+
+### Symbols
+- Avoid using the ampersand symbol (&) except when describing UI elements, writing code examples, or in tables where space is limited
+
+### Punctuation
+- Avoid semicolons
+- Avoid exclamation marks
+- Avoid question marks
+
+## Linking
+
+### Cross-references
+- A good cross-reference describes what information the reader can expect to learn, as well as the exact title (and location) of the page they will be taken to.
+- Do not embed links within a sentence.
+- Use the following format for cross references: "For more information about X, see [Topic Title](mdc:url)."
+- For links to other websites outside of docs.replicated.com, use the following format: "For more information about X, see [Topic Title](mdc:url) in the Company Name documentation." 
+

docs/enterprise/auth-changing-passwords.md

@@ -1,4 +1,4 @@
-# Changing an Admin Console Password
+# Change an Admin Console Password
 
 When you install for the first time with Replicated kURL, the Replicated KOTS Admin Console is secured with a single shared password that is set automatically for all users. Replicated recommends that you change this to a new, unique password for security purposes as this automated password is displayed to the user in plain text.
 
@@ -7,7 +7,7 @@ The Admin Console password is salted and one-way hashed using bcrypt. The irreve
 For more information about bcrypt, see [bcrypt](https://en.wikipedia.org/wiki/Bcrypt) on Wikipedia.
 
 :::note
-Users with Identity Provider (IDP) access cannot change their password using this procedure. If an attempt is made, IDP users receive a message in the user interface to contact the identity service provider to change their password. For more information about resetting an IDP user password, see [Resetting Authentication](auth-identity-provider#resetting-authentication) in _Using an Identity Provider for User Access (Beta)_.
+Users with Identity Provider (IDP) access cannot change their password using this procedure. If an attempt is made, IDP users receive a message in the user interface to contact the identity service provider to change their password. For more information about resetting an IDP user password, see [Resetting Authentication](auth-identity-provider#resetting-authentication) in _Use an Identity Provider for User Access (Beta)_.
 :::
 
 To change your Admin Console password:

docs/enterprise/auth-configuring-rbac.md

@@ -1,4 +1,4 @@
-# Configuring Role-based Access Control (Beta)
+# Configure Role-based Access Control (Beta)
 
 You can regulate access to the Replicated KOTS Admin Console resources based on the roles of individual users within your organization.
 

docs/enterprise/auth-identity-provider.md

@@ -1,4 +1,4 @@
-# Using an Identity Provider for User Access (Beta)
+# Use an Identity Provider for User Access (Beta)
 
 When you install an application for the first time, the Replicated KOTS Admin Console is secured with a single shared password for all users. It is possible to further configure the Admin Console to authenticate users with your organization's user management system. This feature is only available for licenses that have the Replicated identity service feature enabled.
 

docs/enterprise/cluster-management-add-nodes.md

@@ -1,6 +1,6 @@
 import KurlAvailability from "../partials/kurl/_kurl-availability.mdx"
 
-# Adding Nodes to kURL Clusters
+# Add Nodes to kURL Clusters
 
 <KurlAvailability/>
 

docs/enterprise/delete-admin-console.md

@@ -1,4 +1,4 @@
-# Deleting the Admin Console and Removing Applications
+# Delete the Admin Console and Remove Applications
 
 This topic describes how to remove installed applications and delete the Replicated KOTS Admin Console. The information in this topic applies to existing cluster installations with KOTS.
 
@@ -81,4 +81,4 @@ To completely delete the Admin Console from an existing cluster:
    kubectl delete clusterrolebinding kotsadm-rolebinding
    ```
 
-1. (Optional) To uninstall the KOTS CLI, see [Uninstall](https://docs.replicated.com/reference/kots-cli-getting-started#uninstall) in _Installing the KOTS CLI_.   
+1. (Optional) To uninstall the KOTS CLI, see [Uninstall](https://docs.replicated.com/reference/kots-cli-getting-started#uninstall) in _Installing the KOTS CLI_.   

docs/enterprise/embedded-manage-nodes.mdx

@@ -1,6 +1,6 @@
 import HaArchitecture from "../partials/embedded-cluster/_multi-node-ha-arch.mdx"
 
-# Managing Multi-Node Clusters with Embedded Cluster
+# Manage Multi-Node Clusters with Embedded Cluster
 
 This topic describes managing nodes in clusters created with Replicated Embedded Cluster, including how to add nodes and enable high-availability for multi-node clusters.
 
@@ -36,7 +36,7 @@ To add nodes to a cluster:
 
          1. Log in to the Admin Console.
 
-         1. If you promoted a new release that configures the `roles` key in the Embedded Cluster Config, update the instance to the new version. See [Performing Updates in Embedded Clusters](/enterprise/updating-embedded).
+         1. If you promoted a new release that configures the `roles` key in the Embedded Cluster Config, update the instance to the new version. See [Perform Updates in Embedded Clusters](/enterprise/updating-embedded).
 
          1. Go to **Cluster Management > Add node** at the top of the page.
 
@@ -50,7 +50,7 @@ To add nodes to a cluster:
 
      * If the Embedded Cluster Config [roles](/reference/embedded-config#roles) key is not configured, all new nodes joined to the cluster are assigned the `controller` role by default. The `controller` role designates nodes that run the Kubernetes control plane. Controller nodes can also run other workloads, such as application or Replicated KOTS workloads.
 
-     * Roles are not updated or changed after a node is added. If you need to change a node’s role, reset the node and add it again with the new role.
+     * Roles are not updated or changed after a node is added. If you need to change a node's role, reset the node and add it again with the new role.
 
      * For multi-node clusters with high availability (HA), at least three `controller` nodes are required. You can assign both the `controller` role and one or more `custom` roles to the same node. For more information about creating HA clusters with Embedded Cluster, see [Enable High Availability for Multi-Node Clusters (Alpha)](#ha) below.
 

docs/enterprise/embedded-tls-certs.mdx

@@ -1,4 +1,4 @@
-# Updating Custom TLS Certificates in Embedded Cluster Installations
+# Update Custom TLS Certificates in Embedded Cluster Installations
 
 This topic describes how to update custom TLS certificates in Replicated Embedded Cluster installations.
 

docs/enterprise/gitops-managing-secrets.mdx

@@ -1,6 +1,6 @@
 import GitOpsNotRecommended from "../partials/gitops/_gitops-not-recommended.mdx"
 
-# Managing Secrets with KOTS Auto-GitOps (Alpha)
+# Manage Secrets with KOTS Auto-GitOps (Alpha)
 
 <GitOpsNotRecommended/>
 

docs/enterprise/gitops-workflow.mdx

@@ -13,7 +13,7 @@ If you have more than one application installed, you can selectively enable Auto
 
 After enabling the Auto-GitOps workflow for an application, the Admin Console makes your first commit with the latest available version in the Admin Console. The latest available version is often the current version that is deployed. Subsequently, the Admin Console makes separate commits with any available updates.
 
-If you configure automatic updates for the application, any updates from your vendor are automatically committed to your Git repository. For more information about configuring automatic updates, see [Configuring Automatic Updates](/enterprise/updating-apps).
+If you configure automatic updates for the application, any updates from your vendor are automatically committed to your Git repository. For more information about configuring automatic updates, see [Configure Automatic Updates](/enterprise/updating-apps).
 
 You can change your GitOps settings or disable Auto-GitOps at any time from the **GitOps** tab in the Admin Console.
 

docs/enterprise/image-registry-kurl.md

@@ -1,6 +1,6 @@
 import KurlAvailability from "../partials/kurl/_kurl-availability.mdx"
 
-# Working with the kURL Image Registry
+# Work with the kURL Image Registry
 
 <KurlAvailability/>
 
@@ -16,7 +16,7 @@ To keep the registry from running out of storage, images that are no longer used
 For more information about the kURL Registry add-on, see [Registry Add-On](https://kurl.sh/docs/add-ons/registry) in the kURL documentation.
 
 :::note
-Users can also configure their own private registry for kURL installations instead of using the kURL registry. For more information, see [Configuring Local Image Registries](/enterprise/image-registry-settings).
+Users can also configure their own private registry for kURL installations instead of using the kURL registry. For more information, see [Configure Local Image Registries](/enterprise/image-registry-settings).
 :::
 
 ## Trigger Garbage Collection
@@ -66,6 +66,6 @@ The kURL registry image garbage collection feature has following limitations:
 
 * **Shared Image Registries**: The image garbage collection process assumes that the registry is not shared with any other instances of Replicated KOTS, nor shared with any external applications. If the built-in kURL registry is used by another external application, disable garbage collection to prevent image loss.
 
-* **Customer-Supplied Registries**: Image garbage collection is supported only when used with the built-in kURL registry. If the KOTS instance is configured to use a different registry, disable garbage collection to prevent image loss. For more information about configuring an image registry in the Admin Console, see [Configuring Local Image Registries](/enterprise/image-registry-settings).
+* **Customer-Supplied Registries**: Image garbage collection is supported only when used with the built-in kURL registry. If the KOTS instance is configured to use a different registry, disable garbage collection to prevent image loss. For more information about configuring an image registry in the Admin Console, see [Configure Local Image Registries](/enterprise/image-registry-settings).
 
 * **Application Rollbacks**: Image garbage collection has no effect when the `allowRollback` field in the KOTS Application custom resource is set to `true`. For more information, see [Application](/reference/custom-resource-application) in _KOTS Custom Resources_.

docs/enterprise/image-registry-rate-limits.md

@@ -1,4 +1,4 @@
-# Avoiding Docker Hub Rate Limits
+# Avoid Docker Hub Rate Limits
 
 This topic describes how to avoid rate limiting for anonymous and free authenticated use of Docker Hub by providing a Docker Hub username and password to the `kots docker ensure-secret` command.
 

docs/enterprise/image-registry-settings.mdx

@@ -1,7 +1,7 @@
 import ImageRegistrySettings from "../partials/image-registry/_image-registry-settings.mdx"
 import DockerCompatibility from "../partials/image-registry/_docker-compatibility.mdx"
 
-# Configuring Local Image Registries
+# Configure Local Image Registries
 
 This topic describes how to configure private registry settings in the Replicated KOTS Admin Console.
 

docs/enterprise/installing-embedded-air-gap.mdx

@@ -125,7 +125,7 @@ To install with Embedded Cluster in an air gap environment:
 
 1. On the **Nodes** page, you can view details about the machine where you installed, including its node role, status, CPU, and memory. 
 
-     Optionally, add nodes to the cluster before deploying the application. For more information about joining nodes, see [Managing Multi-Node Clusters with Embedded Cluster](/enterprise/embedded-manage-nodes). Click **Continue**.
+     Optionally, add nodes to the cluster before deploying the application. For more information about joining nodes, see [Manage Multi-Node Clusters with Embedded Cluster](/enterprise/embedded-manage-nodes). Click **Continue**.
 
 1. On the **Configure [App Name]** screen, complete the fields for the application configuration options. Click **Continue**.
 

docs/enterprise/installing-embedded-automation.mdx

@@ -1,7 +1,7 @@
 import ConfigValuesExample from "../partials/configValues/_configValuesExample.mdx"
 import ConfigValuesProcedure from "../partials/configValues/_config-values-procedure.mdx"
 
-# Automating Installation with Embedded Cluster
+# Automate Installation with Embedded Cluster
 
 This topic describes how to install an application with Replicated Embedded Cluster from the command line, without needing to access the Replicated KOTS Admin Console.
 

docs/enterprise/installing-embedded.mdx

@@ -87,7 +87,7 @@ To install an application with Embedded Cluster:
 
 1. On the **Nodes** page, you can view details about the machine where you installed, including its node role, status, CPU, and memory. 
 
-     Optionally, add nodes to the cluster before deploying the application. For more information about joining nodes, see [Managing Multi-Node Clusters with Embedded Cluster](/enterprise/embedded-manage-nodes). Click **Continue**.
+     Optionally, add nodes to the cluster before deploying the application. For more information about joining nodes, see [Manage Multi-Node Clusters with Embedded Cluster](/enterprise/embedded-manage-nodes). Click **Continue**.
 
 1. On the **Configure [App Name]** screen, complete the fields for the application configuration options. Click **Continue**.
 

docs/enterprise/installing-existing-cluster-automation.mdx

@@ -11,7 +11,7 @@ import KotsVersionMatch from "../partials/install/_kots-airgap-version-match.mdx
 import PlaceholderRoCreds from "../partials/install/_placeholder-ro-creds.mdx"
 import AccessAdminConsole from "../partials/install/_access-admin-console.mdx"
 
-# Installing with the KOTS CLI
+# Install with the KOTS CLI
 
 This topic describes how to install an application with Replicated KOTS in an existing cluster using the KOTS CLI.
 

docs/enterprise/installing-kurl-airgap.mdx

@@ -120,6 +120,6 @@ To install an application with kURL:
    1. Click the menu in the top right corner of the Admin Console, then click **Change password**.
    1. Enter a new password in the dialog, and click **Change Password** to save.
 
-   Replicated strongly recommends that you change the password from the default provided during installation in a kURL cluster. For more information, see [Changing an Admin Console Password](auth-changing-passwords).
+   Replicated strongly recommends that you change the password from the default provided during installation in a kURL cluster. For more information, see [Change an Admin Console Password](auth-changing-passwords).
 
 1. Add primary and secondary nodes to the cluster. You might add nodes to either meet application requirements or to support your usage of the application. See [Adding Nodes to Embedded Clusters](cluster-management-add-nodes).

docs/enterprise/installing-kurl-automation.mdx

@@ -8,7 +8,7 @@ import DownloadkURLBundle from "../partials/install/_download-kurl-bundle.mdx"
 import ExtractKurlBundle from "../partials/install/_extract-kurl-bundle.mdx"
 import KurlAvailability from "../partials/kurl/_kurl-availability.mdx"
 
-# Installing with kURL from the Command Line
+# Install with kURL from the Command Line
 
 <KurlAvailability/>
 

docs/enterprise/installing-kurl.mdx

@@ -88,6 +88,6 @@ To install an application with kURL:
    1. Click the menu in the top right corner of the Admin Console, then click **Change password**.
    1. Enter a new password in the dialog, and click **Change Password** to save.
 
-   Replicated strongly recommends that you change the password from the default provided during installation in a kURL cluster. For more information, see [Changing an Admin Console Password](auth-changing-passwords).
+   Replicated strongly recommends that you change the password from the default provided during installation in a kURL cluster. For more information, see [Change an Admin Console Password](auth-changing-passwords).
 
 1. Add primary and secondary nodes to the cluster. You might add nodes to either meet application requirements or to support your usage of the application. See [Adding Nodes to Embedded Clusters](cluster-management-add-nodes).

docs/enterprise/installing-overview.md

@@ -30,12 +30,12 @@ For information about image registry requirements, see [Compatible Image Registr
 
 You can automate application installation in online and air-gapped environments using the KOTS CLI. In an automated installation, you provide all the information required to install and deploy the application with the `kots install` command, rather than providing this information in the Replicated Admin Console.
 
-For more information, see [Installing with the KOTS CLI](/enterprise/installing-existing-cluster-automation).
+For more information, see [Install with the KOTS CLI](/enterprise/installing-existing-cluster-automation).
 
 ## KOTS Installations Without Object Storage
 
 The KOTS Admin Console requires persistent storage for state. KOTS deploys MinIO for object storage by default.
 
 You can optionally install KOTS without object storage. When installed without object storage, KOTS deploys the Admin Console as a StatefulSet with an attached PersistentVolume (PV) instead of as a deployment.
 
-For more information about how to install KOTS without object storage, see [Installing KOTS in Existing Clusters Without Object Storage](/enterprise/installing-stateful-component-requirements).
+For more information about how to install KOTS without object storage, see [Install KOTS in Existing Clusters Without Object Storage](/enterprise/installing-stateful-component-requirements).

docs/enterprise/installing-stateful-component-requirements.md

@@ -1,4 +1,4 @@
-# Installing KOTS in Existing Clusters Without Object Storage
+# Install KOTS in Existing Clusters Without Object Storage
 
 This topic describes how to install Replicated KOTS in existing clusters without the default object storage, including limitations of installing without object storage.
 

docs/enterprise/monitoring-access-dashboards.mdx

@@ -1,8 +1,8 @@
-# Accessing Dashboards Using Port Forwarding
+# Access Dashboards Using Port Forwarding
 
 This topic includes information about how to access Prometheus, Grafana, and Alertmanager in Replicated KOTS existing cluster and Replicated kURL installations.
 
-For information about how to configure Prometheus monitoring in existing cluster installations, see [Configuring Prometheus Monitoring in Existing Cluster KOTS Installations](monitoring-applications).
+For information about how to configure Prometheus monitoring in existing cluster installations, see [Configure Prometheus Monitoring in Existing Cluster KOTS Installations](monitoring-applications).
 
 ## Overview
 
@@ -14,7 +14,7 @@ You can also expose these pods on NodePorts or behind an ingress controller. Thi
 
 ## Prerequisite
 
-For existing cluster KOTS installations, first install Prometheus in the cluster and configure monitoring. See [Configuring Prometheus Monitoring in Existing Cluster KOTS Installations](monitoring-applications)
+For existing cluster KOTS installations, first install Prometheus in the cluster and configure monitoring. See [Configure Prometheus Monitoring in Existing Cluster KOTS Installations](monitoring-applications)
 
 ## Access Prometheus