Skip to content

Commit 35b5777

Browse files
author
Daniel Holbach
committed
Fix markup in ordered lists + fenced code groups
- https://facelessuser.github.io/pymdown-extensions/extensions/superfences/ - Make use of !!!note admonitions too for readability Closes: fluxcd#3082
1 parent aca9871 commit 35b5777

File tree

2 files changed

+35
-32
lines changed

2 files changed

+35
-32
lines changed

docs/tutorials/get-started-helm.md

+32-32
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Download Helm v3:
1818

1919
- On MacOS:
2020

21-
```sh
22-
brew install helm
23-
```
21+
```sh
22+
brew install helm
23+
```
2424

2525
- On Linux:
26-
- Download the [latest release](https://github.com/kubernetes/helm/releases/latest),
27-
unpack the tarball and put the binary in your `$PATH`.
26+
- Download the [latest release](https://github.com/kubernetes/helm/releases/latest),
27+
unpack the tarball and put the binary in your `$PATH`.
2828

2929
If you are using Helm v2 you have to create a service account and a cluster role binding for Tiller:
3030

@@ -42,10 +42,11 @@ Deploy Tiller in `kube-system` namespace (Helm v2 only):
4242
helm init --skip-refresh --upgrade --service-account tiller --history-max 10
4343
```
4444

45-
> **Note:** This is a quick guide and by no means a production ready
46-
> Tiller setup, please look into ['Securing your Helm installation'](https://helm.sh/docs/using_helm/#securing-your-helm-installation)
47-
> and be aware of the `--history-max` flag before promoting to
48-
> production.
45+
!!!note
46+
This is a quick guide and by no means a production ready
47+
Tiller setup, please look into ['Securing your Helm installation'](https://helm.sh/docs/using_helm/#securing-your-helm-installation)
48+
and be aware of the `--history-max` flag before promoting to
49+
production.
4950

5051
## Install Flux
5152

@@ -63,41 +64,40 @@ kubectl apply -f https://raw.githubusercontent.com/fluxcd/helm-operator/master/d
6364

6465
In this next step you install Flux using `helm`. Simply
6566

66-
1. Fork [`fluxcd/flux-get-started`](https://github.com/fluxcd/flux-get-started)
67-
on GitHub and replace the `fluxcd` with your GitHub username in
68-
[here](https://github.com/fluxcd/flux-get-started/blob/master/releases/ghost.yaml#L13)
69-
70-
1. Create the flux namespace:
71-
67+
1. Fork [`fluxcd/flux-get-started`](https://github.com/fluxcd/flux-get-started) on GitHub and replace the `fluxcd` with your GitHub username in [here](https://github.com/fluxcd/flux-get-started/blob/master/releases/ghost.yaml#L13)
68+
69+
1. Create the flux namespace:
70+
7271
```sh
7372
kubectl create namespace flux
7473
```
75-
76-
1. Install Flux and the Helm Operator by specifying your fork URL:
7774

78-
*Just make sure you replace `YOURUSER` with your GitHub username
79-
in the command below:*
75+
1. Install Flux and the Helm Operator by specifying your fork URL:
76+
77+
*Just make sure you replace `YOURUSER` with your GitHub username
78+
in the command below:*
8079

8180
- Using a public git server from `bitbucket.com`, `github.com`, `gitlab.com`, `dev.azure.com`, or `vs-ssh.visualstudio.com`:
8281

83-
```sh
84-
helm upgrade -i flux fluxcd/flux \
85-
--set git.url=git@github.com:YOURUSER/flux-get-started \
86-
--namespace flux
82+
```sh
83+
helm upgrade -i flux fluxcd/flux \
84+
--set git.url=git@github.com:YOURUSER/flux-get-started \
85+
--namespace flux
8786
88-
helm upgrade -i helm-operator fluxcd/helm-operator \
89-
--set git.ssh.secretName=flux-git-deploy \
90-
--namespace flux
91-
```
87+
helm upgrade -i helm-operator fluxcd/helm-operator \
88+
--set git.ssh.secretName=flux-git-deploy \
89+
--namespace flux
90+
```
9291

93-
> **Note:** By default the helm-operator chart will install with support for both Helm v2 (which requires Tiller) and v3. You can target specific versions by setting the `helm.versions` value, e.g. `--set helm.versions=v3`.
92+
!!!note
93+
By default the helm-operator chart will install with support for both Helm v2 (which requires Tiller) and v3. You can target specific versions by setting the `helm.versions` value, e.g. `--set helm.versions=v3`.
9494

9595
- Using a private git server:
9696

97-
When deploying from a private repo, the known_hosts of the git server needs
98-
to be configured into a kubernetes configmap so that `StrictHostKeyChecking` is respected.
99-
See the [README of the chart](https://github.com/fluxcd/flux/blob/master/chart/flux/README.md#to-install-flux-with-the-helm-operator-and-a-private-git-repository)
100-
for further installation instructions in this case.
97+
When deploying from a private repo, the known_hosts of the git server needs
98+
to be configured into a kubernetes configmap so that `StrictHostKeyChecking` is respected.
99+
See the [README of the chart](https://github.com/fluxcd/flux/blob/master/chart/flux/README.md#to-install-flux-with-the-helm-operator-and-a-private-git-repository)
100+
for further installation instructions in this case.
101101

102102
Allow some time for all containers to get up and running. If you're
103103
impatient, run the following command and see the pod creation

mkdocs.yml

+3
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,11 @@ markdown_extensions:
3030
guess_lang: false
3131
- toc:
3232
permalink: true
33+
- pymdownx.superfences:
34+
highlight_code: true
3335
- pymdownx.tabbed
3436

37+
3538
nav:
3639
- Introducing Flux: introduction.md
3740
- Requirements and limitations: requirements.md

0 commit comments

Comments
 (0)