docs: improve Notes within the documentation (#962)

keptn · Mar 20, 2023 · 4e69699 · 4e69699
1 parent abd4e09
commit 4e69699
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 16 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -149,7 +149,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).
 

diff --git a/docs/README.md b/docs/README.md
@@ -14,7 +14,7 @@ make build
 make server
 ```
 
-> **Note:**
+> **Note**
 If the above command is not working try with `sudo` command.
 
 After the server is running on <http://localhost:1314>.

diff --git a/docs/content/en/docs/crd-ref/_index.md b/docs/content/en/docs/crd-ref/_index.md
@@ -9,7 +9,7 @@ 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:**
+> **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.

diff --git a/docs/content/en/docs/getting-started.md b/docs/content/en/docs/getting-started.md
@@ -143,8 +143,8 @@ by describing one of the resources:
 kubectl describe keptnworkloadinstances podtato-head-podtato-head-entry -n podtato-kubectl
 ```
 
-Note that the event stream of the object contains more detailed information.
-</details>
+> **Note**
+The event stream of the object contains more detailed informatio
 
 <details>
 <summary>Watch application state</summary>

diff --git a/klt-cert-manager/README.md b/klt-cert-manager/README.md
@@ -14,7 +14,8 @@ 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:**
+
+> **Note**
 Your controller will automatically use the current context in your kubeconfig file (i.e. whatever
 cluster `kubectl cluster-info` shows).
 
@@ -79,7 +80,7 @@ make install
 make run
 ```
 
-> **Note:**
+> **Note**
 You can also run this in one step by running: `make install run`
 
 ### Modifying the API definitions
@@ -90,7 +91,7 @@ If you are editing the API definitions, generate the manifests such as CRs or CR
 make manifests
 ```
 
-> **Note:**
+> **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)
diff --git a/metrics-operator/README.md b/metrics-operator/README.md
@@ -11,7 +11,7 @@
 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:**
+> **Note**
 Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster
 `kubectl cluster-info` shows).
 
@@ -76,7 +76,7 @@ which provides a reconcile function responsible for synchronizing resources unti
     make run
     ```
 
-> **Note:**
+> **Note**
 You can also run this in one step by running: `make install run`
 
 ### Modifying the API definitions
@@ -87,7 +87,7 @@ If you are editing the API definitions, generate the manifests such as CRs or CR
 make manifests
 ```
 
-> **Note:**
+> **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)

diff --git a/operator/README.md b/operator/README.md
@@ -10,7 +10,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:**
+
+> **Note**
 Your controller will automatically use the current context in your kubeconfig file (i.e. whatever
 cluster `kubectl cluster-info` shows).
 
@@ -77,7 +78,7 @@ make install
 make run
 ```
 
-> **Note:**
+> **Note**
 You can also run this in one step by running: `make install run`
 
 ### Modifying the API definitions
@@ -88,7 +89,7 @@ If you are editing the API definitions, generate the manifests such as CRs or CR
 make manifests
 ```
 
-> **Note:**
+> **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)

diff --git a/scheduler/README.md b/scheduler/README.md
@@ -10,7 +10,8 @@
 
 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:**
+
+> **Note**
 Your controller will automatically use the current context in your kubeconfig file (i.e. whatever
 cluster `kubectl cluster-info` shows).
 
@@ -22,7 +23,7 @@ cluster `kubectl cluster-info` shows).
 make build-and-push-local RELEASE_REGISTRY=<some-registry>
 ```
 
-> **Note:**
+> **Note**
 Run `make --help` for more information on all potential `make` targets
 
 1. Generate your release manifest