Merge branch 'main' into fharper/vault

konstructio · Oct 2, 2023 · b2319a4 · b2319a4
2 parents fdd6170 + ca00011
commit b2319a4
Show file tree

Hide file tree

Showing 26 changed files with 38 additions and 41 deletions.
diff --git a/SUPPORT.MD b/SUPPORT.MD
@@ -1,9 +1,9 @@
 # Support
 
-## Issues
+## Documentation
 
-If you are having an issue with kubefirst, we highly suggest that you share the problem with us on our Slack Community (read the next section for more information). If you are certain it's a bug with our platform, you can create an [issue](https://github.com/kubefirst/kubefirst/issues/new/choose). We'll get back to you as soon as possible.
+If something isn't clear, not working or you don't find the information you are looking for, please let us know in the #helping-hands channel of our [Slack community](https://kubefirst.io/slack). We are striving to always provide the best documentation there is, and it's only possible with your help.
 
-## Questions
+## kubefirst
 
-If you have a question about how to use Kubefirst, please join our [Slack community](https://kubefirst.io/slack), and ask your question in the `#helping-hands` channel. If you prefer to ask in private, you can send a direct message to our Principal Developer Advocate, Frédéric Harper, `@Fred` on Slack.
+For any issues with kubefirst, please refer yourself to the [SUPPORT.md from the kubefirst repository](https://github.com/kubefirst/kubefirst/blob/main/SUPPORT.MD).
diff --git a/docs/aws/faq.mdx b/docs/aws/faq.mdx
@@ -1,6 +1,5 @@
 ---
-hide_title: true
-sidebar_label: FAQ
+title: FAQ
 # custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md
 description: frequently asked quesitons about the platform
 image: "https://docs.kubefirst.io/img/logo.svg"

diff --git a/docs/aws/quick-start/install/cli.mdx b/docs/aws/quick-start/install/cli.mdx
@@ -28,6 +28,8 @@ export const TabLabel = ({ imgSrc, label }) => (
   </div>
 );
 
+# Install kubefirst from the CLI
+
 <Tabs groupId="git_provider" defaultValue="github" queryString>
   <TabItem
     attributes={{ className: styles.github }}

diff --git a/docs/aws/quick-start/install/ui.mdx b/docs/aws/quick-start/install/ui.mdx
@@ -6,9 +6,9 @@ sidebar_position: 1
 image: "https://docs.kubefirst.io/img/logo.svg"
 ---
 
-There are a few ways to install kubefirst, whether you have a cluster already or don't.
+# Install kubefirst using the UI
 
-# Install kubefirst
+There are a few ways to install kubefirst, whether you have a cluster already or don't.
 
 ## Step 1: Install kubefirst console
 

diff --git a/docs/aws/quick-start/repositories.mdx b/docs/aws/quick-start/repositories.mdx
@@ -1,6 +1,5 @@
 ---
-hide_title: true
-sidebar_label: Repositories
+title: Repositories
 sidebar_position: 2
 # custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md
 description: the git repositories created by the kubefirst platform

diff --git a/docs/civo/credits.mdx b/docs/civo/credits.mdx
@@ -1,6 +1,5 @@
 ---
-hide_title: true
-sidebar_label: Credits
+title: Credits
 # custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md
 description: credit to all the awesome open source projects
 image: "https://docs.kubefirst.io/img/logo.svg"

diff --git a/docs/civo/overview.mdx b/docs/civo/overview.mdx
@@ -1,5 +1,4 @@
 ---
-hide_title: true
 sidebar_label: Overview
 sidebar_position: 1
 # custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md
@@ -29,8 +28,6 @@ import CommonProvisionProcess from "../common/partials/common/_provision-process
   </div>
 </div>
 
-# Overview
-
 The Civo provisioning process will:
 <CommonProvisionProcess firstitem="Create a Kubernetes cluster in the Civo cloud."/>
 

diff --git a/docs/civo/quick-start/install/cli.mdx b/docs/civo/quick-start/install/cli.mdx
@@ -28,6 +28,8 @@ export const TabLabel = ({ imgSrc, label }) => (
   </div>
 );
 
+# Install kubefirst from the CLI
+
 <Tabs groupId="git_provider" defaultValue="github" queryString>
   <TabItem
     attributes={{ className: styles.github }}

diff --git a/docs/civo/quick-start/install/marketplace.mdx b/docs/civo/quick-start/install/marketplace.mdx
@@ -6,6 +6,8 @@ sidebar_position: 1
 image: "https://docs.kubefirst.io/img/logo.svg"
 ---
 
+# 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.
 
 ## Create your installer cluster

diff --git a/docs/civo/quick-start/install/ui.mdx b/docs/civo/quick-start/install/ui.mdx
@@ -6,9 +6,9 @@ sidebar_position: 2
 image: "https://docs.kubefirst.io/img/logo.svg"
 ---
 
-There are a few ways to install kubefirst, whether you have a cluster already or don't.
+# Install kubefirst using the UI
 
-# Install kubefirst
+There are a few ways to install kubefirst, whether you have a cluster already or don't.
 
 ## Step 1: Install kubefirst console
 

diff --git a/docs/civo/quick-start/repositories.mdx b/docs/civo/quick-start/repositories.mdx
@@ -1,6 +1,5 @@
 ---
-hide_title: true
-sidebar_label: Repositories
+title: Repositories
 sidebar_position: 3
 # custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md
 description: the installation process for kubefirst cli

diff --git a/docs/common/credits.mdx b/docs/common/credits.mdx
@@ -1,3 +1,5 @@
+# Credits
+
 ## 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.

diff --git a/docs/common/gitops.mdx b/docs/common/gitops.mdx
@@ -1,5 +1,3 @@
-# kubefirst GitOps CI/CD
-
 The days of scripting `kubectl apply` and `helm install` in your operations are over. The kubefirst platform comes with all the tools you need to run a scalable GitOps platform powered by Argo CD GitOps.
 
 ![GitOps Flow](../img/gitops/gitops-diagram-light.png#light-mode)![GitOps Flow](../img/gitops/gitops-diagram-dark.png#dark-mode)

diff --git a/docs/common/metaphor.mdx b/docs/common/metaphor.mdx
@@ -1,6 +1,3 @@
-
-# Metaphor
-
 The [metaphor](https://github.com/kubefirst/gitops-template/tree/main/metaphor) application is an example application with source code, builds, and GitOps delivery used to showcase various features, integrations, and best practices of the kubefirst platform. It's useful to keep on your new platform as a place to test CI changes or anything you need to verify on the platform. The metaphor app has CI/CD that delivers each application to a development, staging, and production namespace in your Kubernetes cluster. The metaphor service applications' secrets in HashiCorp Vault are bound to the metaphor application through the use of the external secrets operator, a handy Kubernetes utility to keep Kubernetes secrets in sync with the Vault, the source of truth. It demonstrates how DNS entries are automatically created in AWS Route 53 using external DNS, and has auto-renewing, short-lived certificates generated by cert-manager and the Let's Encrypt cluster-issuer.
 
 ## Best Practices

diff --git a/docs/common/telemetry.mdx b/docs/common/telemetry.mdx
@@ -1,5 +1,3 @@
-# kubefirst Telemetry
-
 kubefirst collects data in order to optimize future releases. By collecting metrics on what type of clusters are being deployed and how they are being used, kubefirst prioritizes the features that are being used across the majority of the user base. While we rely on this data to make improvements to the platform, you are always allowed to opt out for any reason.
 
 ## What Metrics are collected?

diff --git a/docs/common/vault.mdx b/docs/common/vault.mdx
@@ -1,6 +1,7 @@
-
 [Vault](https://www.vaultproject.io) is an open source secrets manager and identity provider created by HashiCorp.
 
+## Authentification
+
 ### Token authentication
 
 ![Vault section of the handoff screen](../img/vault/handoff-screen.png)

diff --git a/docs/do/quick-start/install/cli.mdx b/docs/do/quick-start/install/cli.mdx
@@ -28,6 +28,8 @@ export const TabLabel = ({ imgSrc, label }) => (
   </div>
 );
 
+# Install kubefirst from the CLI
+
 <Tabs groupId="git_provider" defaultValue="github" queryString>
   <TabItem
     attributes={{ className: styles.github }}

diff --git a/docs/do/quick-start/install/ui.mdx b/docs/do/quick-start/install/ui.mdx
@@ -6,9 +6,9 @@ sidebar_position: 1
 image: "https://docs.kubefirst.io/img/logo.svg"
 ---
 
-There are a few ways to install kubefirst, whether you have a cluster already or don't.
+# Install kubefirst using the UI
 
-# Install kubefirst
+There are a few ways to install kubefirst, whether you have a cluster already or don't.
 
 ## Step 1: Install kubefirst console
 

diff --git a/docs/do/quick-start/repositories.mdx b/docs/do/quick-start/repositories.mdx
@@ -1,6 +1,5 @@
 ---
-hide_title: true
-sidebar_label: Repositories
+title: Repositories
 sidebar_position: 3
 # custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md
 description: the installation process for kubefirst cli

diff --git a/docs/gcp/quick-start/install/cli.mdx b/docs/gcp/quick-start/install/cli.mdx
@@ -28,6 +28,8 @@ export const TabLabel = ({ imgSrc, label }) => (
   </div>
 );
 
+# Install kubefirst from the CLI
+
 <Tabs groupId="git_provider" defaultValue="github" queryString>
   <TabItem
     attributes={{ className: styles.github }}

diff --git a/docs/gcp/quick-start/install/ui.mdx b/docs/gcp/quick-start/install/ui.mdx
@@ -6,9 +6,9 @@ sidebar_position: 1
 image: "https://docs.kubefirst.io/img/logo.svg"
 ---
 
-There are a few ways to install kubefirst, whether you have a cluster already or don't.
+# Install kubefirst using the UI
 
-# Install kubefirst
+There are a few ways to install kubefirst, whether you have a cluster already or don't.
 
 ## Step 1: Install kubefirst console
 

diff --git a/docs/gcp/quick-start/repositories.mdx b/docs/gcp/quick-start/repositories.mdx
@@ -1,6 +1,5 @@
 ---
-hide_title: true
-sidebar_label: Repositories
+title: Repositories
 sidebar_position: 3
 # custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md
 description: the installation process for kubefirst cli

diff --git a/docs/k3d/quick-start/repositories.mdx b/docs/k3d/quick-start/repositories.mdx
@@ -1,6 +1,5 @@
 ---
-hide_title: true
-sidebar_label: Repositories
+title: Repositories
 sidebar_position: 3
 # custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md
 image: "https://docs.kubefirst.io/img/logo.svg"

diff --git a/docs/vultr/quick-start/install/cli.mdx b/docs/vultr/quick-start/install/cli.mdx
@@ -28,6 +28,8 @@ export const TabLabel = ({ imgSrc, label }) => (
   </div>
 );
 
+# Install kubefirst from the CLI
+
 <Tabs groupId="git_provider" defaultValue="github" queryString>
   <TabItem
     attributes={{ className: styles.github }}

diff --git a/docs/vultr/quick-start/install/ui.mdx b/docs/vultr/quick-start/install/ui.mdx
@@ -6,9 +6,9 @@ sidebar_position: 1
 image: "https://docs.kubefirst.io/img/logo.svg"
 ---
 
-There are a few ways to install kubefirst, whether you have a cluster already or don't.
+# Install kubefirst using the UI
 
-# Install kubefirst
+There are a few ways to install kubefirst, whether you have a cluster already or don't.
 
 ## Step 1: Install kubefirst console
 

diff --git a/docs/vultr/quick-start/repositories.mdx b/docs/vultr/quick-start/repositories.mdx
@@ -1,6 +1,5 @@
 ---
-hide_title: true
-sidebar_label: Repositories
+title: Repositories
 sidebar_position: 3
 # custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md
 description: the installation process for kubefirst cli