chore: capitalise references to Kubefirst (#824)

Co-authored-by: Frédéric Harper <[email protected]>
konstructio · Nov 13, 2024 · 99bf8b6 · 99bf8b6
1 parent 4f5925c
commit 99bf8b6
Show file tree

Hide file tree

Showing 71 changed files with 172 additions and 168 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -1,11 +1,14 @@
 {
     "name": "devcontainer",
     "image": "ghcr.io/kubefirst/devcontainers/full",
-    "features": {},
+    "features": {
+      "ghcr.io/shinepukur/devcontainer-features/vale:1": {}
+    },
     "customizations": {
       "vscode": {
         "extensions": [
-          "unifiedjs.vscode-mdx"
+          "unifiedjs.vscode-mdx",
+          "ChrisChinchilla.vale-vscode"
         ],
         "settings": {}
       }

diff --git a/.vale/Custom/ignore.txt b/.vale/Custom/ignore.txt
@@ -37,7 +37,7 @@ iam
 
 # K
 kubeconfig
-kubefirst
+Kubefirst
 kubernetes
 
 # L

diff --git a/.vale/Custom/substitutions.yml b/.vale/Custom/substitutions.yml
@@ -39,7 +39,7 @@ swap:
   https: HTTPS
   iam: IAM
   konstruct: Konstruct
-  # kubefirst: Kubefirst # Need to be activated again once we will fix all the lower cases.
+  # kubefirst: Kubefirst
   kubernetes: Kubernetes
   mongo: MongoDB
   oidc: OIDC

diff --git a/.vale/config/vocabularies/base/accept.txt b/.vale/config/vocabularies/base/accept.txt
@@ -44,6 +44,7 @@ kbot
 KMS
 Konstruct
 kubectl
+Kubefirst
 
 # L
 Linode

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -36,7 +36,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement by [email](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,7 +4,7 @@ Firstly, we want to thank you for investing your valuable time to contribute to
 
 Note we have a [code of conduct](CODE_OF_CONDUCT.md) which needs to be followed in all your interactions with the project to keep our community healthy.
 
-_For contribution to the Kubefirst CLI, please refer yourself to the [CONTRIBUTING.md](https://github.com/konstructio/kubefirst/blob/main/CONTRIBUTING.md) from the [kubefirst repository](https://github.com/konstructio/kubefirst)._
+_For contribution to the Kubefirst CLI, please refer yourself to the [CONTRIBUTING.md](https://github.com/konstructio/kubefirst/blob/main/CONTRIBUTING.md) from the [Kubefirst repository](https://github.com/konstructio/kubefirst)._
 
 - [Ways to Contribute](#ways-to-contribute)
 - [Getting Started](#getting-started)

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
   </picture>
 </p>
 
-# kubefirst Docs
+# Kubefirst Docs
 
 Welcome to the open source repository that powers [the Kubefirst documentation](https://kubefirst.konstruct.io/docs).
 

diff --git a/docs/akamai/partials/common/_installed-applications.mdx b/docs/akamai/partials/common/_installed-applications.mdx
@@ -1,3 +1,3 @@
 ### Installed Applications
 
-To see what is installed by kubefirst, check the [overview page](../../overview.mdx).
+To see what is installed by Kubefirst, check the [overview page](../../overview.mdx).
diff --git a/docs/akamai/partials/common/_prerequisites.mdx b/docs/akamai/partials/common/_prerequisites.mdx
@@ -1,6 +1,6 @@
 ### Akamai Prerequisites
 
-For kubefirst to be able to provision your Akamai cloud resources:
+For Kubefirst to be able to provision your Akamai cloud resources:
 
 - A [Akamai account](https://www.akamai.com/create-account) in which you are an account owner.
 - A [Linode API token](https://cloud.linode.com/profile/tokens).
diff --git a/docs/akamai/partials/github/_cluster-create.mdx b/docs/akamai/partials/github/_cluster-create.mdx
@@ -1,6 +1,6 @@
 import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx";
 
-## Create your new kubefirst cluster
+## Create your new Kubefirst cluster
 
 Adjust the following command with your GitHub and Akamai (Linode) tokens in addition to the appropriate values for your new platform.
 

diff --git a/docs/akamai/partials/gitlab/_cluster-create.mdx b/docs/akamai/partials/gitlab/_cluster-create.mdx
@@ -1,6 +1,6 @@
 import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx";
 
-## Create your new kubefirst cluster
+## Create your new Kubefirst cluster
 
 Adjust the following command with your GitHub and Akamai (Linode) tokens in addition to the appropriate values for your new platform.
 

diff --git a/docs/aws/advanced/certificates.mdx b/docs/aws/advanced/certificates.mdx
@@ -10,4 +10,4 @@ import AWSLogo from '../../img/aws/logo.svg';
 
 ## SSL Certificates
 
-In cloud versions of the kubefirst platform, we use [cert-manager](https://cert-manager.io/) with a [Let's Encrypt](https://letsencrypt.org) ClusterIssuer for TLS encryption to all of our services on Ingress. These certificates are requested automatically, and will auto-renew.
+In cloud versions of the Kubefirst platform, we use [cert-manager](https://cert-manager.io/) with a [Let's Encrypt](https://letsencrypt.org) ClusterIssuer for TLS encryption to all of our services on Ingress. These certificates are requested automatically, and will auto-renew.
diff --git a/docs/aws/advanced/security.mdx b/docs/aws/advanced/security.mdx
@@ -10,7 +10,7 @@ import AWSLogo from '../../img/aws/logo.svg';
 
 ## Installation Account
 
-kubefirst runs against your public cloud provider and leverages your personal cloud credentials in order to conduct the provisioning of the kubefirst platform. We do not embed your credentials into the platform in any way, they are only used during the installation process.
+Kubefirst runs against your public cloud provider and leverages your personal cloud credentials in order to conduct the provisioning of the Kubefirst platform. We do not embed your credentials into the platform in any way, they are only used during the installation process.
 
 ## Granular Kubernetes Service Accounts with Explicit IAM Roles for Cloud Access
 

diff --git a/docs/aws/partials/common/_ecr.mdx b/docs/aws/partials/common/_ecr.mdx
@@ -1,5 +1,5 @@
 :::tip
 
-By default kubefirst use the Git provider you selected as container registry. With AWS, you have the option to use EKS instead. To do so, add the flag `--ecr` with the value `true` to your cluster creation command.
+By default Kubefirst use the Git provider you selected as container registry. With AWS, you have the option to use EKS instead. To do so, add the flag `--ecr` with the value `true` to your cluster creation command.
 
 :::
diff --git a/docs/aws/partials/github/_cluster-create.mdx b/docs/aws/partials/github/_cluster-create.mdx
@@ -1,7 +1,7 @@
 import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx";
 import ECR from "../common/_ecr.mdx";
 
-## Create your new kubefirst cluster
+## Create your new Kubefirst cluster
 
 Adjust the following command with your GitHub token in addition to the appropriate values for your new platform.
 

diff --git a/docs/aws/partials/gitlab/_cluster-create.mdx b/docs/aws/partials/gitlab/_cluster-create.mdx
@@ -1,7 +1,7 @@
 import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx";
 import ECR from "../common/_ecr.mdx";
 
-## Create your new kubefirst cluster
+## Create your new Kubefirst cluster
 
 Adjust the following command with your GitLab token in addition to the appropriate values for your new platform.
 

diff --git a/docs/civo/partials/common/_installed-applications.mdx b/docs/civo/partials/common/_installed-applications.mdx
@@ -1,3 +1,3 @@
 ### Installed Applications
 
-To see what is installed by kubefirst, check the [overview page](../../overview.mdx).
+To see what is installed by Kubefirst, check the [overview page](../../overview.mdx).
diff --git a/docs/civo/partials/common/_prerequisites.mdx b/docs/civo/partials/common/_prerequisites.mdx
@@ -1,13 +1,13 @@
 ### Civo Prerequisites
 
-For kubefirst to be able to provision your Civo cloud resources:
+For Kubefirst to be able to provision your Civo cloud resources:
 
 - A [Civo account](https://dashboard.civo.com/signup) in which you are an account owner.
 - A publicly routable [DNS](https://www.civo.com/learn/configure-dns#adding-a-domain-name).
 - A [Civo token](https://dashboard.civo.com/security).
 
 :::info
-kubefirst is keeping low the resources needed to create your Kubernetes cluster, but if you are already using Civo, note that you may have exceeding quota issues during the creation process.
+Kubefirst is keeping low the resources needed to create your Kubernetes cluster, but if you are already using Civo, note that you may have exceeding quota issues during the creation process.
 
 Civo has a quota based on a combined allocation of instances/Kubernetes nodes, CPUs, RAM usage, and other resources. All customers start with a [basic quota level](https://www.civo.com/docs/account/quota), but you can [request quota increase](https://www.civo.com/docs/account/quota#requesting-a-quota-increase).
 :::
diff --git a/docs/civo/partials/github/_cluster-create.mdx b/docs/civo/partials/github/_cluster-create.mdx
@@ -1,6 +1,6 @@
 import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx";
 
-## Create your new kubefirst cluster
+## Create your new Kubefirst cluster
 
 Adjust the following command with your GitHub and Civo tokens in addition to the appropriate values for your new platform.
 

diff --git a/docs/civo/partials/gitlab/_cluster-create.mdx b/docs/civo/partials/gitlab/_cluster-create.mdx
@@ -1,6 +1,6 @@
 import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx";
 
-## Create your new kubefirst cluster
+## Create your new Kubefirst cluster
 
 Adjust the following command with your GitHub and Civo tokens in addition to the appropriate values for your new platform.
 

diff --git a/docs/civo/quick-start/install/marketplace.mdx b/docs/civo/quick-start/install/marketplace.mdx
@@ -5,9 +5,9 @@ sidebar_position: 1
 image: "https://kubefirst.konstruct.io/docs/img/kubefirst.svg"
 ---
 
-# Install kubefirst using the Civo Marketplace
+# Install Kubefirst using the Civo Marketplace
 
-You can create a temporary kubefirst installer cluster through the Civo Kubernetes marketplace, and use it to create your kubefirst management cluster.
+You can create a temporary Kubefirst installer cluster through the Civo Kubernetes marketplace, and use it to create your Kubefirst management cluster.
 
 ## Create your installer cluster
 
@@ -20,9 +20,9 @@ Log into your Civo account and navigate to [Kubernetes](https://dashboard.civo.c
 5. In the Marketplace section select `kubefirst`
 6. Click Create Cluster and wait until the cluster is ready
 
-![kubefirst user interface showing cloud and git options](../../../img/civo/marketplace/installer-options.png)
+![Kubefirst user interface showing cloud and git options](../../../img/civo/marketplace/installer-options.png)
 
-## Connect to the install cluster and the kubefirst installer service
+## Connect to the install cluster and the Kubefirst installer service
 
 In your terminal, run the following commands to download and use your new cluster's kubeconfig. This example assumes you named your cluster `installer`.
 
@@ -35,12 +35,12 @@ Then launch the installer in your browser:
 
 [http://localhost:8080/](http://localhost:8080/)
 
-## Create your kubefirst management cluster
+## Create your Kubefirst management cluster
 
-Provide details about your preferred Git provider, access, and cluster details and let kubefirst do the rest.
+Provide details about your preferred Git provider, access, and cluster details and let Kubefirst do the rest.
 
-![kubefirst user interface showing cloud and git options](../../../img/civo/marketplace/create-management.png)
+![Kubefirst user interface showing cloud and git options](../../../img/civo/marketplace/create-management.png)
 
 ## Deleting your installer cluster
 
-Once you've successfully installed your kubefirst `management` cluster, you can delete the `installer` cluster directly in the Civo UI. It is only used to establish the platform.
+Once you've successfully installed your Kubefirst `management` cluster, you can delete the `installer` cluster directly in the Civo UI. It is only used to establish the platform.
diff --git a/docs/common/clusters.mdx b/docs/common/clusters.mdx
@@ -1,10 +1,10 @@
-The kubefirst 2.3 release introduces Kubernetes cluster lifecycle management to the platform to provide our users with the ability to create their own opinionated workload clusters in a way that takes advantage of their management cluster. We're introducing both physical clusters, which will be created in your cloud account, as well as virtual clusters, which are also isolated Kubernetes clusters, but which run inside your management cluster.
+The Kubefirst 2.3 release introduces Kubernetes cluster lifecycle management to the platform to provide our users with the ability to create their own opinionated workload clusters in a way that takes advantage of their management cluster. We're introducing both physical clusters, which will be created in your cloud account, as well as virtual clusters, which are also isolated Kubernetes clusters, but which run inside your management cluster.
 
-![cluster creation in kubefirst user interface](../img/kubefirst/getting-started/cluster-creation.gif)
+![cluster creation in Kubefirst user interface](../img/kubefirst/getting-started/cluster-creation.gif)
 
 ## GitOps-Oriented Workload Clusters
 
-By default, a new kubefirst will provide you with 2 template-driven directories that will drive how your workload clusters are created.
+By default, a new Kubefirst will provide you with 2 template-driven directories that will drive how your workload clusters are created.
 
 ![cluster template directories in GitOps repository](../img/kubefirst/getting-started/cluster-template.png)
 
@@ -33,9 +33,9 @@ If you inspect your templates for cluster and vcluster, you'll find them to be v
 - you can customize this template in your `gitops` repository as your needs require
 
 :::tip
-The kubefirst Console "Physical Clusters" feature will be the first feature of our upcoming Pro tier. We'd love for you to try it out and tell us what you think during its free introductory period.
+The Kubefirst Console "Physical Clusters" feature will be the first feature of our upcoming Pro tier. We'd love for you to try it out and tell us what you think during its free introductory period.
 
-We plan to keep the kubefirst Console "Virtual Clusters" feature on the Community tier at no cost.
+We plan to keep the Kubefirst Console "Virtual Clusters" feature on the Community tier at no cost.
 
 You will always be able to create anything you need on your own without our user interface, and we hope you find that starting point immensely valuable. We hope to earn your business with our management interface. Thank you sincerely to all of our customers.
 :::
@@ -48,4 +48,4 @@ Cluster creation takes about 6 minutes to fully sync in Argo CD for virtual clus
 
 Your workload cluster will have a starting point app-of-apps in Argo CD in the `clusters` app and will share your cluster's name.
 
-When you delete a cluster, kubefirst will remove the binding from your management cluster so that it begins deleting in Argo CD, but we must leave the directory there so that the apps can remove gracefully. You're free to remove it once cluster deprovisioning has completed successfully. Deletion takes time to deprovision resources - can be anywhere from 5 to 15 minutes depending on the cloud. Be patient and inspect the deprovision operation in Argo CD.
+When you delete a cluster, Kubefirst will remove the binding from your management cluster so that it begins deleting in Argo CD, but we must leave the directory there so that the apps can remove gracefully. You're free to remove it once cluster deprovisioning has completed successfully. Deletion takes time to deprovision resources - can be anywhere from 5 to 15 minutes depending on the cloud. Be patient and inspect the deprovision operation in Argo CD.
diff --git a/docs/common/credits.mdx b/docs/common/credits.mdx
@@ -1,6 +1,6 @@
 ## The Tools We Love
 
-The kubefirst platform uses some of the most popular open source projects in the world, and some closed sources ones (as little as possible). This page is dedicated to giving those projects credit for their incredible offerings.
+The Kubefirst platform uses some of the most popular open source projects in the world, and some closed sources ones (as little as possible). This page is dedicated to giving those projects credit for their incredible offerings.
 
 - [Actions Runner Controller](https://github.com/actions/actions-runner-controller) ([Apache 2.0](https://github.com/external-secrets/external-secrets/blob/main/LICENSE))
 - [Argo CD](https://github.com/argoproj/argo-cd) ([Apache 2.0](https://github.com/argoproj/argo-cd/blob/master/LICENSE))
@@ -27,7 +27,7 @@ The kubefirst platform uses some of the most popular open source projects in the
 - [vcluster](https://github.com/loft-sh/vcluster) ([Apache 2.0](https://github.com/loft-sh/vcluster/blob/main/LICENSE))
 
 :::note
-Please evaluate each licenses for third-party products used by kubefirst to validate if you can legally use them for your specific use case and legal status.
+Please evaluate each licenses for third-party products used by Kubefirst to validate if you can legally use them for your specific use case and legal status.
 :::
 
 ### Additional References

diff --git a/docs/common/deprovision.mdx b/docs/common/deprovision.mdx
@@ -15,13 +15,13 @@ import GetAkamaiKubeconfig from '../akamai/partials/common/_get-kubeconfig.mdx';
 
 # Deprovision
 
-To destroy your kubefirst cluster, complete the following steps.
+To destroy your Kubefirst cluster, complete the following steps.
 
 ## Prerequisites
 
-### kubefirst CLI
+### Kubefirst CLI
 
-If you are coming from a cloud marketplace, and didn't use the kubefirst CLI, you will need to install it first.
+If you are coming from a cloud marketplace, and didn't use the Kubefirst CLI, you will need to install it first.
 
 ```shell
 brew install konstructio/taps/kubefirst
@@ -125,7 +125,7 @@ This will collect the required variables from the necessary secret path and outp
 If for some reason, Vault wasn't correctly deployed and initiated when you created your cluster, this step won't generate a proper `.env` file. You will still need to continue the deprovision process as it doesn't mean the cluster or other resources weren't created properly. You will either need to set some environment variable manually (see the tip at the [Cloud Provider](#cloud-provider) step to see all values needed) or provide them to Terraform when asked.
 :::
 
-Next, you will need to clone the `gitops` repository generated by kubefirst during the initial cluster creation:
+Next, you will need to clone the `gitops` repository generated by Kubefirst during the initial cluster creation:
 
 ```shell
 # GitHub
@@ -147,7 +147,7 @@ Switch to the `terraform` directory inside of the cloned `gitops` repository. Fo
 cd gitops/terraform
 ```
 
-Within the `terraform` directory, there are several subdirectories that contain the infrastructure-as-code declarations for your kubefirst resources.
+Within the `terraform` directory, there are several subdirectories that contain the infrastructure-as-code declarations for your Kubefirst resources.
 
 #### Cloud Provider
 
@@ -189,7 +189,7 @@ terraform init
 terraform destroy
 ```
 
-Once you've destroyed `terraform` resources for the cloud and git providers, the only resource left to clean up is the state storage objects that kubefirst created on your behalf. If you'd like to remove these, this can be achieved by using the cloud console or the command-line utility for your chosen cloud provider.
+Once you've destroyed `terraform` resources for the cloud and git providers, the only resource left to clean up is the state storage objects that Kubefirst created on your behalf. If you'd like to remove these, this can be achieved by using the cloud console or the command-line utility for your chosen cloud provider.
 
 You can now delete the `gitops` repository you cloned on your computer, and the `.env` file:
 
@@ -201,7 +201,7 @@ rm .env
 
 ### Console UI
 
-No matter is you created your new cluster, using the CLI directly (`kubefirst <cloud> create`) or by using the console UI (`kubefirst launch up`), kubefirst will have created a k3d cluster in Docker. We call it the cluster 0, which is either used to display the Console UI, or to connect to our API and create your new kubefirst cluster directly from the CLI. Since it's not needed anymore, you need to destroy it by running:
+No matter is you created your new cluster, using the CLI directly (`kubefirst <cloud> create`) or by using the console UI (`kubefirst launch up`), Kubefirst will have created a k3d cluster in Docker. We call it the cluster 0, which is either used to display the Console UI, or to connect to our API and create your new Kubefirst cluster directly from the CLI. Since it's not needed anymore, you need to destroy it by running:
 
 ```shell
 kubefirst launch down