Skip to content

Commit

Permalink
docs: remove indentation to fix code blocks (#2751)
Browse files Browse the repository at this point in the history
Signed-off-by: Florian Bacher <[email protected]>
Co-authored-by: Meg McRoberts <[email protected]>
  • Loading branch information
bacherfl and StackScribe authored Jan 5, 2024
1 parent 47d573f commit 9807986
Show file tree
Hide file tree
Showing 9 changed files with 161 additions and 169 deletions.
26 changes: 13 additions & 13 deletions docs-new/docs/contribute/docs/contrib-guidelines-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,21 +68,21 @@ that are relevant only to documentation
A good practice is to just code all links on their own page.
So, instead of coding:

```shell
The [Other section](long-link-to-section) page
...
```
```shell
The [Other section](long-link-to-section) page
...
```

you should code the following,
unless the link is so short
that you are sure it will not violate the line-length rules::

```shell
The
[Other section](long-link-to-section)
page
...
```
```shell
The
[Other section](long-link-to-section)
page
...
```

* Always build the documentation locally to check the formatting
and verify that all links are working properly.
Expand All @@ -92,9 +92,9 @@ that are relevant only to documentation
* Always run the following to fix most markdown issues in your PR
and identify issues that can not be fixed automatically:

```shell
make markdownlint-fix
```
```shell
make markdownlint-fix
```

See [Markdownlint](./linter-requirements.md#markdownlint)
for details.
18 changes: 9 additions & 9 deletions docs-new/docs/contribute/docs/local-building.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ To set up a local Docsy build:

1. Execute the following command from the `docs` folder of your clone:

```shell
make server
```
```shell
make server
```

It will continue running in its own shell.

Expand Down Expand Up @@ -72,10 +72,10 @@ to check your formatting, you have the following options:
you can format the specified file locally
by running the following in its own shell:

```shell
grip <file>.md
```
```shell
grip <file>.md
```

Point your browser at `localhost:6419` to view the formatted file.
The document updates automatically
each time you write your changes to disk.
Point your browser at `localhost:6419` to view the formatted file.
The document updates automatically
each time you write your changes to disk.
30 changes: 15 additions & 15 deletions docs-new/docs/contribute/software/dev-environ.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@ you need to install the following on your system:
For example, the following command builds the environment
and pushes the image to the `docker.io/exampleuser` github repository:

```shell
make build-deploy-dev-environment RELEASE_REGISTRY=docker.io/exampleuser TAG=main
```
```shell
make build-deploy-dev-environment RELEASE_REGISTRY=docker.io/exampleuser TAG=main
```

The build commands are defined in the
[Makefile](https://github.com/keptn/lifecycle-toolkit/blob/main/Makefile)
Expand All @@ -124,9 +124,9 @@ You are now ready to make your changes to the source code.
only the one you modified.
For example, if your modifications are to the `metrics-operator`, run:

```shell
make build-deploy-metrics-operator RELEASE_REGISTRY=docker.io/exampleuser TAG=my-feature
```
```shell
make build-deploy-metrics-operator RELEASE_REGISTRY=docker.io/exampleuser TAG=my-feature
```

## Testing

Expand All @@ -148,23 +148,23 @@ Study these errors, modify your code, and rerun the test until it passes.

1. Run the integration tests from the root directory of your clone:

```shell
make integration-test-local
```
```shell
make integration-test-local
```

`integration-test-local` cleans up after the test.

1. From the `lifecycle-operator` directory, run the component test:

```shell
make component-test
```
```shell
make component-test
```

1. From the `lifecycle-operator` directory, run the end-to-end tests:

```shell
make e2e-test
```
```shell
make e2e-test
```

## Create and manage the PR

Expand Down
22 changes: 11 additions & 11 deletions docs-new/docs/guides/dora.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,23 +35,23 @@ To view DORA metrics, run the following two commands:

- Retrieve the service name with:

```shell
kubectl -n keptn-system get service \
-l control-plane=lifecycle-operator
```
```shell
kubectl -n keptn-system get service \
-l control-plane=lifecycle-operator
```

- Then port-forward to the name of your service:

```shell
kubectl -n keptn-system port-forward \
service/<YOURNAME> 2222
```
```shell
kubectl -n keptn-system port-forward \
service/<YOURNAME> 2222
```

Then view the metrics at:

```shell
http://localhost:2222/metrics
```
```shell
http://localhost:2222/metrics
```

DORA metrics are also displayed on Grafana
or whatever dashboard application you choose.
Expand Down
26 changes: 13 additions & 13 deletions docs-new/docs/guides/otel.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,21 +51,21 @@ you must have the following on your cluster:
See
[Setup for Monitoring other Namespaces](https://prometheus-operator.dev/docs/kube/monitoring-other-namespaces/)).

- To install Prometheus into the `monitoring` namespace
using the example configuration included with Keptn,
use the following command sequence.
You can modify these commands to define a different configuration:
- To install Prometheus into the `monitoring` namespace
using the example configuration included with Keptn,
use the following command sequence.
You can modify these commands to define a different configuration:

> **Note**
You must clone the `lifecycle-toolkit` repository
and `cd` into the correct directory
(`examples/support/observability`) before running the following commands.

```shell
kubectl create namespace monitoring
kubectl apply --server-side -f config/prometheus/setup/
kubectl apply -f config/prometheus/
```
You must clone the `lifecycle-toolkit` repository
and `cd` into the correct directory
(`examples/support/observability`) before running the following commands.

```shell
kubectl create namespace monitoring
kubectl apply --server-side -f config/prometheus/setup/
kubectl apply -f config/prometheus/
```

- If you want a dashboard for reviewing metrics and traces:

Expand Down
52 changes: 26 additions & 26 deletions docs-new/docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,26 +90,26 @@ Some helpful hints:
To get the appropriate chart version for the Keptn version you want,
use the following command:

```shell
helm search repo keptn --versions
```
```shell
helm search repo keptn --versions
```

You see that the "CHART VERSION" for `keptn/keptn` v0.9.0 is 0.3.0
so use the following command to explicitly installs Keptn v0.9.0:

```shell
helm upgrade --install keptn keptn/keptn \
--version 0.3.0 \
-n keptn-system --create-namespace --wait
```
```shell
helm upgrade --install keptn keptn/keptn \
--version 0.3.0 \
-n keptn-system --create-namespace --wait
```

* To view which Keptn components are installed in your cluster
and verify that they are the correct ones,
run the following command:

```shell
kubectl get pods -n keptn-system
```
```shell
kubectl get pods -n keptn-system
```

The output shows all Keptn components that are running on your cluster.

Expand Down Expand Up @@ -174,38 +174,38 @@ To modify Helm values:

1. Download a copy of the Helm values file:

```shell
helm show values keptn/keptn > values.yaml
```
```shell
helm show values keptn/keptn > values.yaml
```

1. Edit your local copy to modify some values

1. Add the following string
to your `helm upgrade` command to install Keptn
with your configuration changes:

```shell
--values=values.yaml
```
```shell
--values=values.yaml
```

For example, if you create a `my.values.yaml`
and modify some configuration values,
use the following command to apply your configuration:

```shell
helm upgrade --install keptn keptn/keptn \
--values my.values.yaml \
-n keptn-system --create-namespace --wait
```
```shell
helm upgrade --install keptn keptn/keptn \
--values my.values.yaml \
-n keptn-system --create-namespace --wait
```

You can also use the `--set` flag
to specify a value change for the `helm upgrade --install` command.
Helm values are specified using the format:

```shell
--set key1=value1 \
--set key2=value2 ...
```
```shell
--set key1=value1 \
--set key2=value2 ...
```

## Control what components are installed

Expand Down
8 changes: 2 additions & 6 deletions docs-new/docs/installation/k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ The basic steps are:
2. Download [KinD](https://kind.sigs.k8s.io/)
3. Create the local KinD cluster with the following command:

```shell
kind create cluster
```
kind create cluster

See the
[KinD Quick Start Guide](https://kind.sigs.k8s.io/docs/user/quick-start/)
Expand All @@ -42,9 +40,7 @@ The basic steps are:
and that it is running a supported version of Kubernetes
with the following command:

```shell
kubectl version --short
```
kubectl version --short

## Prepare your cluster for Keptn

Expand Down
Loading

0 comments on commit 9807986

Please sign in to comment.