Skip to content

Commit

Permalink
docs: improve Notes within the documentation
Browse files Browse the repository at this point in the history
With this little changes, `Notes` are way better visible and
follow the standard definition which can also be used within
GitHub markdown.

Instead of

**NOTE:** a note

we do

> **Note**
a note

Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
  • Loading branch information
aepfli committed Mar 3, 2023
1 parent ef35387 commit 4ace6af
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 15 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ of the settings.

If you are on Windows, you need to install **make** for the above process to complete.

( **NOTE**:
> **Note**
When using the make command on Windows, you may receive an `unrecognized command` error for a command that is installed.
This usually indicates that `PATH` for the binary is not set correctly).

Expand Down
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ make build
make server
```

Note: If the above command is not working try with `sudo` command.
> **Note**
If the above command is not working try with `sudo` command.

After the server is running on <http://localhost:1314>.
Any modification in the docs folder will be reflected on the server under the dev revision.
Expand Down
3 changes: 2 additions & 1 deletion docs/content/en/docs/crd-ref/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ This section provides comprehensive reference information about the
[Custom Resource Definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
that are defined for the Keptn Lifecycle Toolkit.

**NOTE: This section is under development.
> **Note**
This section is under development.
Information that is published here has been reviewed for technical accuracy
but the format and content is still evolving.
We welcome your input!**
3 changes: 2 additions & 1 deletion docs/content/en/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,8 @@ information about the workloads by describing one of the resources:
kubectl describe keptnworkloadinstances podtato-head-podtato-head-entry -n podtato-kubectl
```

Note that there are more detailed information in the event stream of the object.
> **Note**
There are more detailed information in the event stream of the object.

### Watch application state

Expand Down
10 changes: 7 additions & 3 deletions klt-cert-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ operator deployment changes.

You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for
testing, or run against a remote cluster.
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever

> **Note**
Your controller will automatically use the current context in your kubeconfig file (i.e. whatever
cluster `kubectl cluster-info` shows).

### Running on the cluster
Expand Down Expand Up @@ -78,7 +80,8 @@ make install
make run
```

**NOTE:** You can also run this in one step by running: `make install run`
> **Note**
You can also run this in one step by running: `make install run`

### Modifying the API definitions

Expand All @@ -88,6 +91,7 @@ If you are editing the API definitions, generate the manifests such as CRs or CR
make manifests
```

**NOTE:** Run `make --help` for more information on all potential `make` targets
> **Note**
Run `make --help` for more information on all potential `make` targets

More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
9 changes: 6 additions & 3 deletions metrics-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster
for testing, or run against a remote cluster.

**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster
> **Note**
Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster
`kubectl cluster-info` shows).

### Running on the cluster
Expand Down Expand Up @@ -75,7 +76,8 @@ which provides a reconcile function responsible for synchronizing resources unti
make run
```

**NOTE:** You can also run this in one step by running: `make install run`
> **Note**
You can also run this in one step by running: `make install run`

### Modifying the API definitions

Expand All @@ -85,7 +87,8 @@ If you are editing the API definitions, generate the manifests such as CRs or CR
make manifests
```

**NOTE:** Run `make --help` for more information on all potential `make` targets
> **Note**
Run `make --help` for more information on all potential `make` targets

More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)

Expand Down
10 changes: 7 additions & 3 deletions operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@

You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for
testing, or run against a remote cluster.
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever

> **Note**
Your controller will automatically use the current context in your kubeconfig file (i.e. whatever
cluster `kubectl cluster-info` shows).

### Running on the cluster
Expand Down Expand Up @@ -76,7 +78,8 @@ make install
make run
```

**NOTE:** You can also run this in one step by running: `make install run`
> **Note**
You can also run this in one step by running: `make install run`

### Modifying the API definitions

Expand All @@ -86,7 +89,8 @@ If you are editing the API definitions, generate the manifests such as CRs or CR
make manifests
```

**NOTE:** Run `make --help` for more information on all potential `make` targets
> **Note**
Run `make --help` for more information on all potential `make` targets

More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)

Expand Down
7 changes: 5 additions & 2 deletions scheduler/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@

You’ll need a Kubernetes cluster v0.24.0 or higher to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a
local cluster for testing, or run against a remote cluster.
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever

> **Note**
Your controller will automatically use the current context in your kubeconfig file (i.e. whatever
cluster `kubectl cluster-info` shows).

### Running on the cluster
Expand All @@ -21,7 +23,8 @@ cluster `kubectl cluster-info` shows).
make build-and-push-local RELEASE_REGISTRY=<some-registry>
```

**NOTE:** Run `make --help` for more information on all potential `make` targets
> **Note**
Run `make --help` for more information on all potential `make` targets

1. Generate your release manifest

Expand Down

0 comments on commit 4ace6af

Please sign in to comment.