diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8e565fb35f..9159106c67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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). diff --git a/docs/README.md b/docs/README.md index e4d8ad858b..1def400ead 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 . Any modification in the docs folder will be reflected on the server under the dev revision. diff --git a/docs/content/en/docs/crd-ref/_index.md b/docs/content/en/docs/crd-ref/_index.md index 23e517ce9c..74d80ea22b 100644 --- a/docs/content/en/docs/crd-ref/_index.md +++ b/docs/content/en/docs/crd-ref/_index.md @@ -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!** diff --git a/docs/content/en/docs/getting-started.md b/docs/content/en/docs/getting-started.md index 7315e37174..3a41e6e12e 100644 --- a/docs/content/en/docs/getting-started.md +++ b/docs/content/en/docs/getting-started.md @@ -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 diff --git a/klt-cert-manager/README.md b/klt-cert-manager/README.md index 7989b73675..8dce7c1d30 100644 --- a/klt-cert-manager/README.md +++ b/klt-cert-manager/README.md @@ -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 @@ -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 @@ -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) diff --git a/metrics-operator/README.md b/metrics-operator/README.md index 70c2a3d7e8..1e17674453 100644 --- a/metrics-operator/README.md +++ b/metrics-operator/README.md @@ -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 @@ -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 @@ -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) diff --git a/operator/README.md b/operator/README.md index c59c55595c..a8718448c4 100644 --- a/operator/README.md +++ b/operator/README.md @@ -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 @@ -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 @@ -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) diff --git a/scheduler/README.md b/scheduler/README.md index 5b4c2254b6..560353b8e9 100644 --- a/scheduler/README.md +++ b/scheduler/README.md @@ -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 @@ -21,7 +23,8 @@ cluster `kubectl cluster-info` shows). make build-and-push-local RELEASE_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