Skip to content

Commit

Permalink
fix: 2.2 docs Markdown issues
Browse files Browse the repository at this point in the history
  • Loading branch information
fharper committed Jul 18, 2023
1 parent 913a1b0 commit 5dc547e
Show file tree
Hide file tree
Showing 46 changed files with 127 additions and 145 deletions.
2 changes: 1 addition & 1 deletion versioned_docs/version-2.2/aws/advanced/certificates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ On local versions of the kubefirst platform, we leverage [mkcert](https://github

To trust mkcerts in your browser, run

```bash
```shell
mkcert -install
```
7 changes: 4 additions & 3 deletions versioned_docs/version-2.2/aws/advanced/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-m
description: the installation process for kubefirst cli
image: "https://docs.kubefirst.io/img/logo.svg"
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import styles from "@site/docs/stylesheets/tabs.module.css";
Expand All @@ -28,9 +29,9 @@ import GitHubInstall from '@site/docs/aws/partials/github/_install.mdx'
import GitLabInstall from '@site/docs/aws/partials/gitlab/_install.mdx'

<Tabs groupId="git_provider" defaultValue="github" queryString>
<TabItem
<TabItem
attributes={{className: styles.github}}
value="github"
value="github"
label={
<div className="git-tab">
<img src="https://assets.kubefirst.com/console/github.svg" />
Expand All @@ -40,7 +41,7 @@ import GitLabInstall from '@site/docs/aws/partials/gitlab/_install.mdx'
>
<GitHubInstall />
</TabItem>
<TabItem
<TabItem
value="gitlab"
attributes={{className: styles.gitlab}}
label={
Expand Down
5 changes: 3 additions & 2 deletions versioned_docs/version-2.2/aws/explore/user-creation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: User Creation
sidebar_position: 5
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import styles from "@site/docs/stylesheets/tabs.module.css";
Expand All @@ -13,7 +14,7 @@ import GitLabUserCreation from '@site/docs/civo/partials/gitlab/_user-creation.m
<TabItem value="github" label="GitHub" attributes={{className: styles.github}}>
<GitHubUserCreation />
</TabItem>
<TabItem value="gitlab" label="GitLab" attributes={{className: styles.gitlab}}>
<TabItem value="gitlab" label="GitLab" attributes={{className: styles.gitlab}}>
<GitLabUserCreation />
</TabItem>
</Tabs>
</Tabs>
8 changes: 4 additions & 4 deletions versioned_docs/version-2.2/aws/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ import GitLabOverview from '@site/docs/aws/partials/gitlab/_overview.mdx'
# Overview

The aws provisioning process will:

- create a vpc, subnets, iam, and eks cluster in your specified aws account
<!-- details below this line apply everywhere -->
- create a gitops git repository from our gitops-template, customized for you, and store it in your git provider
- install argocd and register it with your gitops repo so that your main branch powers the platform
- install all the platform apps using argocd gitops preconfigured sync waves (gitops repo `/registry` folder)
Expand All @@ -47,9 +47,9 @@ The aws provisioning process will:
# Applications

<Tabs groupId="git_provider" defaultValue="github" queryString>
<TabItem
<TabItem
attributes={{className: styles.github}}
value="github"
value="github"
label={
<div className="git-tab">
<img src="https://assets.kubefirst.com/console/github.svg" />
Expand All @@ -59,7 +59,7 @@ The aws provisioning process will:
>
<GitHubOverview />
</TabItem>
<TabItem
<TabItem
value="gitlab"
attributes={{className: styles.gitlab}}
label={
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

To connect to your new Kubernetes cluster, run

```bash
```shell
export KUBECONFIG=~/.k1/kubeconfig
```

To view all cluster pods, run

```bash
```shell
kubectl get pods -A
```
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ There are other ways to install kubefirst for different operating systems, archi
1. Create an AWS account with billing enabled.
2. Establish a public hosted zone with DNS routing established ([docs](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/AboutHZWorkingWith.html)).
3. Connect with [Administrator Access](https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/AdministratorAccessserviceLevelSummary) IAM credentials to your AWS account ([docs](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys)).
4. Our Homebrew package will automatically install the [AWS IAM Authenticator](https://docs.aws.amazon.com/eks/latest/userguide/install-aws-iam-authenticator.html) dependency. If you use another installation method, you will need to install this utility.
4. Our Homebrew package will automatically install the [AWS IAM Authenticator](https://docs.aws.amazon.com/eks/latest/userguide/install-aws-iam-authenticator.html) dependency. If you use another installation method, you will need to install this utility.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

To obtain your 3 initial passwords, run

```bash
```shell
kubefirst aws root-credentials
```

Expand Down
8 changes: 4 additions & 4 deletions versioned_docs/version-2.2/aws/partials/github/_install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ kubefirst aws create \

To obtain your 3 initial passwords, run

```bash
```shell
kubefirst aws root-credentials
```

Expand All @@ -60,12 +60,12 @@ kubefirst aws root-credentials

Replace `kubefirst` in the command below with your cluster's name if you specified one

```bash
```shell
aws eks update-kubeconfig --name kubefirst
```

To view all cluster pods run

```bash
```shell
kubectl get pods -A
```
```
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ That was just GitHub. Take a look at all the Terraform providers that are availa

To make infrastructure and configuration changes with Terraform, simply open a pull request against any of the Terraform directory folders in the `gitops` repository. Your pull request will automatically provide plans, state locks, and applies, and even comment in the merge request itself. You'll have a simple, peer reviewable, auditable changelog of all infrastructure and configuration changes.

![Atlantis GitHub](../../../img/common/github/atlantis.png)
![Atlantis GitHub](../../../img/common/github/atlantis.png)
8 changes: 4 additions & 4 deletions versioned_docs/version-2.2/aws/partials/gitlab/_install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ kubefirst aws create \

To obtain your 3 initial passwords, run

```bash
```shell
kubefirst aws root-credentials
```

Expand All @@ -64,12 +64,12 @@ kubefirst aws root-credentials

Replace `kubefirst` in the command below with your cluster's name if you specified one

```bash
```shell
aws eks update-kubeconfig --name kubefirst
```

To view all cluster pods run

```bash
```shell
kubectl get pods -A
```
```
24 changes: 8 additions & 16 deletions versioned_docs/version-2.2/aws/quick-start/install/ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ 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.

<!-- TODO: 2.1 - update chart version, arm/amd, atlas, etc -->

# Install Kubefirst

## Step 1: Install kubefirst console
Expand All @@ -18,11 +16,9 @@ There are a few ways to install kubefirst, whether you have a cluster already or

# Helm

This will install our platform installer tools to your existing cluster so you can
create your new management cluster in your favorite cloud provider using your
favorite git provider.
This will install our platform installer tools to your existing cluster so you can create your new management cluster in your favorite cloud provider using your favorite git provider.

```
```shell
helm repo add kubefirst https://charts.kubefirst.com
helm repo update

Expand All @@ -35,14 +31,11 @@ Then connect to the provisioning tool at [http://localhost:8080](http://localhos

# Helm (ARM / M1 Mac / M2 Mac)

This will install our platform installer UI to your existing cluster so you can
create your new management cluster in your favorite cloud provider using your
favorite git provider.
This will install our platform installer UI to your existing cluster so you can create your new management cluster in your favorite cloud provider using your favorite git provider.

This example shows a couple additional helm values settings that enable mongo to
run on the ARM architecture.
This example shows a couple additional helm values settings that enable mongo to run on the ARM architecture.

```
```shell
helm repo add kubefirst https://charts.kubefirst.com
helm repo update

Expand All @@ -62,14 +55,13 @@ Then connect to the provisioning tool at [http://localhost:8080](http://localhos

**No cluster? No problem!** Let us create your bootstrap cluster for you as well. We'll install our provisioning tool into it to create your permanent infrastructure.

```
```shell
brew install kubefirst/tools/kubefirst

kubefirst launch up
```

Then connect to the provisioning tool at
[https://console.kubefirst.dev](https://console.kubefirst.dev )
Then connect to the provisioning tool at [https://console.kubefirst.dev](https://console.kubefirst.dev )

:::note
The kubefirst.dev domain is only available after `kubefirst launch up` and resolves to the host machine.
Expand All @@ -81,4 +73,4 @@ The kubefirst.dev domain is only available after `kubefirst launch up` and resol

Provide details about your preferred git provider, cloud provider, access, and cluster details and let kubefirst do the rest.

![kubefirst user interface showing cloud and git options](../../../img/console/installer.png)
![kubefirst user interface showing cloud and git options](../../../img/console/installer.png)
7 changes: 4 additions & 3 deletions versioned_docs/version-2.2/aws/quick-start/repositories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_position: 2
description: the git repositories created by the kubefirst platform
image: "https://docs.kubefirst.io/img/logo.svg"
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import styles from "@site/docs/stylesheets/tabs.module.css";
Expand All @@ -28,9 +29,9 @@ import GitHubRepositories from '@site/docs/aws/partials/github/_repositories.mdx
import GitLabRepositories from '@site/docs/aws/partials/gitlab/_repositories.mdx'

<Tabs groupId="git_provider" defaultValue="github" queryString>
<TabItem
<TabItem
attributes={{className: styles.github}}
value="github"
value="github"
label={
<div className="git-tab">
<img src="https://assets.kubefirst.com/console/github.svg" />
Expand All @@ -40,7 +41,7 @@ import GitLabRepositories from '@site/docs/aws/partials/gitlab/_repositories.mdx
>
<GitHubRepositories />
</TabItem>
<TabItem
<TabItem
value="gitlab"
attributes={{className: styles.gitlab}}
label={
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-2.2/civo/credits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ image: "https://docs.kubefirst.io/img/logo.svg"

import CommonCredits from "@site/docs/common/credits.mdx"

<CommonCredits />
<CommonCredits />
9 changes: 5 additions & 4 deletions versioned_docs/version-2.2/civo/explore/user-creation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: User Creation
sidebar_position: 5
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import styles from "@site/docs/stylesheets/tabs.module.css";
Expand All @@ -10,9 +11,9 @@ import GitHubUserCreation from '@site/docs/civo/partials/github/_user-creation.m
import GitLabUserCreation from '@site/docs/civo/partials/gitlab/_user-creation.mdx'

<Tabs groupId="git_provider" defaultValue="github" queryString>
<TabItem
<TabItem
attributes={{className: styles.github}}
value="github"
value="github"
label={
<div className="git-tab">
<img src="https://assets.kubefirst.com/console/github.svg" />
Expand All @@ -22,7 +23,7 @@ import GitLabUserCreation from '@site/docs/civo/partials/gitlab/_user-creation.m
>
<GitHubUserCreation />
</TabItem>
<TabItem
<TabItem
value="gitlab"
attributes={{className: styles.gitlab}}
label={
Expand All @@ -34,4 +35,4 @@ import GitLabUserCreation from '@site/docs/civo/partials/gitlab/_user-creation.m
>
<GitLabUserCreation />
</TabItem>
</Tabs>
</Tabs>
9 changes: 5 additions & 4 deletions versioned_docs/version-2.2/civo/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_position: 1
description: an overview of kubefirst on a civo kubernetes cluster
image: "https://docs.kubefirst.io/img/logo.svg"
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import styles from "@site/docs/stylesheets/tabs.module.css";
Expand All @@ -28,10 +29,10 @@ import CloudBanner from '@site/src/components/CloudBanner/CloudBanner.jsx'
</div>
</div>


# Overview

The Civo provisioning process will:

- create a gitops git repository from our gitops-template and store it in your git provider
- create a kubernetes cluster in the Civo cloud
- install argocd bootstrapped against your gitops repo so your repo powers the platform
Expand All @@ -47,9 +48,9 @@ The Civo provisioning process will:
# Applications

<Tabs groupId="git_provider" defaultValue="github" queryString>
<TabItem
<TabItem
attributes={{className: styles.github}}
value="github"
value="github"
label={
<div className="git-tab">
<img src="https://assets.kubefirst.com/console/github.svg" />
Expand All @@ -59,7 +60,7 @@ The Civo provisioning process will:
>
<GitHubOverview />
</TabItem>
<TabItem
<TabItem
value="gitlab"
attributes={{className: styles.gitlab}}
label={
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

To connect to your new Kubernetes cluster, run

```bash
```shell
export KUBECONFIG=~/.k1/kubeconfig
```

To view all cluster pods, run

```bash
```shell
kubectl get pods -A
```
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

To obtain your 3 initial passwords, run

```bash
```shell
kubefirst civo root-credentials
```

Expand Down
Loading

0 comments on commit 5dc547e

Please sign in to comment.