From 143fb278029a0aa4845243c5bc0a1dec90cdc0fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabiano=20Fid=C3=AAncio?= Date: Tue, 23 Nov 2021 13:24:42 +0100 Subject: [PATCH] kata-deploy: Use the default notation for "Note" MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Let's use the default GitHub notation for notes in documentation, as describe here: https://github.com/kata-containers/kata-containers/blob/main/docs/Documentation-Requirements.md#notes Signed-off-by: Fabiano Fidêncio Suggested-by: James O. D. Hunt --- tools/packaging/kata-deploy/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tools/packaging/kata-deploy/README.md b/tools/packaging/kata-deploy/README.md index cf4286e8b..b6d455adc 100644 --- a/tools/packaging/kata-deploy/README.md +++ b/tools/packaging/kata-deploy/README.md @@ -4,8 +4,8 @@ and artifacts required to run Kata Containers, as well as reference DaemonSets, which can be utilized to install Kata Containers on a running Kubernetes cluster. -Note, installation through DaemonSets successfully installs `katacontainers.io/kata-runtime` on -a node only if it uses either containerd or CRI-O CRI-shims. +> **Note**: installation through DaemonSets successfully installs `katacontainers.io/kata-runtime` +> on a node only if it uses either containerd or CRI-O CRI-shims. ## Kubernetes quick start @@ -24,8 +24,8 @@ $ kubectl apply -f https://raw.githubusercontent.com/kata-containers/kata-contai The stable image refers to the last stable releases content. -Note that if you use a tagged version of the repo, the stable image does match that version. -For instance, if you use the 2.2.1 tagged version of the kata-deploy.yaml file, then the version 2.2.1 of the kata runtime will be deployed. +> **Note:** if you use a tagged version of the repo, the stable image does match that version. +> For instance, if you use the 2.2.1 tagged version of the kata-deploy.yaml file, then the version 2.2.1 of the kata runtime will be deployed. ```sh $ kubectl apply -f https://raw.githubusercontent.com/kata-containers/kata-containers/main/tools/packaging/kata-deploy/kata-rbac/base/kata-rbac.yaml