From acece84906fa13ee05f501cf116fe315cdd1d2b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabiano=20Fid=C3=AAncio?= Date: Tue, 23 Nov 2021 13:27:35 +0100 Subject: [PATCH] docs: Use the default notation for "Note" on install README 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-Requir Signed-off-by: Fabiano Fidêncio Suggested-by: James O. D. Hunt --- docs/install/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/install/README.md b/docs/install/README.md index 7b5cd02291..65cab61153 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -12,8 +12,8 @@ Containers. Packaged installation methods uses your distribution's native package format (such as RPM or DEB). -*Note:* We encourage installation methods that provides automatic updates, it ensures security updates and bug fixes are -easily applied. +> **Note:** We encourage installation methods that provides automatic updates, it ensures security updates and bug fixes are +> easily applied. | Installation method | Description | Automatic updates | Use case | |------------------------------------------------------|---------------------------------------------------------------------|-------------------|----------------------------------------------------------| @@ -48,9 +48,9 @@ Follow the [containerd installation guide](container-manager/containerd/containe ## Build from source installation -*Note:* Power users who decide to build from sources should be aware of the -implications of using an unpackaged system which will not be automatically -updated as new [releases](../Stable-Branch-Strategy.md) are made available. +> **Note:** Power users who decide to build from sources should be aware of the +> implications of using an unpackaged system which will not be automatically +> updated as new [releases](../Stable-Branch-Strategy.md) are made available. [Building from sources](../Developer-Guide.md#initial-setup) allows power users who are comfortable building software from source to use the latest component