From 2ac2f41c224fe8029467728c7fe3235890cb54cb Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Wed, 23 May 2018 14:22:45 +0100 Subject: [PATCH 1/4] docs: Apply standard formatting for Note Make the leading Note in the install guides use the standard note formatting. Signed-off-by: James O. D. Hunt --- install/centos-installation-guide.md | 5 +++-- install/fedora-installation-guide.md | 6 +++--- install/ubuntu-installation-guide.md | 7 ++++--- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/install/centos-installation-guide.md b/install/centos-installation-guide.md index 38a7edb050..1cd950e903 100644 --- a/install/centos-installation-guide.md +++ b/install/centos-installation-guide.md @@ -1,6 +1,6 @@ # Installing Kata Containers on CentOS -Note: Kata Containers is available for CentOS version 7. +> **Note:** Kata Containers is available for CentOS version 7. This step is only required in case Docker is not installed on the system. 1. Install the latest version of Docker with the following commands: @@ -15,7 +15,8 @@ For more information on installing Docker please refer to the 2. Install the Kata Containers components with the following commands: - **Note:** The repository redirects the download content to use `http`, be aware that this installation channel is not secure. +> **Note:** The repository redirects the download content to use `http`, be aware that this installation channel is not secure. + ```bash $ source /etc/os-release $ sudo -E VERSION_ID=$VERSION_ID yum-config-manager --add-repo \ diff --git a/install/fedora-installation-guide.md b/install/fedora-installation-guide.md index 23fd5f1548..93e430aae6 100644 --- a/install/fedora-installation-guide.md +++ b/install/fedora-installation-guide.md @@ -1,7 +1,6 @@ # Installing Kata Containers on Fedora -Note: -Kata Containers is available for Fedora\* versions **26** and **27**. +> **Note:** Kata Containers is available for Fedora\* versions **26** and **27**. This step is only required in case Docker is not installed on the system. 1. Install the latest version of Docker with the following commands: @@ -18,7 +17,8 @@ For more information on installing Docker please refer to the 2. Install the Kata Containers components with the following commands: - **Note:** The repository redirects the download content to use `http`, be aware that this installation channel is not secure. +> **Note:** The repository redirects the download content to use `http`, be aware that this installation channel is not secure. + ```bash $ source /etc/os-release $ sudo -E VERSION_ID=$VERSION_ID dnf config-manager --add-repo \ diff --git a/install/ubuntu-installation-guide.md b/install/ubuntu-installation-guide.md index 980479e0b4..ce7cafd435 100644 --- a/install/ubuntu-installation-guide.md +++ b/install/ubuntu-installation-guide.md @@ -1,7 +1,7 @@ # Installing Kata Containers on Ubuntu -Note: -Kata Containers is available for Ubuntu\* **16.04** and **17.10**. +> **Note:** Kata Containers is available for Ubuntu\* **16.04** and **17.10**. + Currently Kata Containers is currently only build for x86_64. @@ -22,7 +22,8 @@ For more information on installing Docker please refer to the 2. Install the Kata Containers components with the following commands: - **Note:** The repository is downloading content using `http`, be aware that this installation channel is not secure. +> **Note:** The repository is downloading content using `http`, be aware that this installation channel is not secure. + ```bash $ sudo sh -c "echo 'deb http://download.opensuse.org/repositories/home:/katacontainers:/release/xUbuntu_$(lsb_release -rs)/ /' > /etc/apt/sources.list.d/kata-containers.list" $ curl -sL http://download.opensuse.org/repositories/home:/katacontainers:/release/xUbuntu_$(lsb_release -rs)/Release.key | sudo apt-key add - From 62459fe5919226c7ef21abeda8029561dd09d2ba Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Wed, 23 May 2018 14:25:37 +0100 Subject: [PATCH 2/4] docs: Explain packages are x86_only currently Update the install guides to explain that packages are currently only available on x86_64. Signed-off-by: James O. D. Hunt --- install/centos-installation-guide.md | 2 +- install/fedora-installation-guide.md | 2 +- install/ubuntu-installation-guide.md | 5 +---- 3 files changed, 3 insertions(+), 6 deletions(-) diff --git a/install/centos-installation-guide.md b/install/centos-installation-guide.md index 1cd950e903..55d56d24f2 100644 --- a/install/centos-installation-guide.md +++ b/install/centos-installation-guide.md @@ -1,6 +1,6 @@ # Installing Kata Containers on CentOS -> **Note:** Kata Containers is available for CentOS version 7. +> **Note:** Kata Containers packages are available for CentOS version 7 (currently `x86_64` only). This step is only required in case Docker is not installed on the system. 1. Install the latest version of Docker with the following commands: diff --git a/install/fedora-installation-guide.md b/install/fedora-installation-guide.md index 93e430aae6..699c1f95c6 100644 --- a/install/fedora-installation-guide.md +++ b/install/fedora-installation-guide.md @@ -1,6 +1,6 @@ # Installing Kata Containers on Fedora -> **Note:** Kata Containers is available for Fedora\* versions **26** and **27**. +> **Note:** Kata Containers packages are available for Fedora\* versions **26** and **27** (currently `x86_64` only). This step is only required in case Docker is not installed on the system. 1. Install the latest version of Docker with the following commands: diff --git a/install/ubuntu-installation-guide.md b/install/ubuntu-installation-guide.md index ce7cafd435..43a6e102d2 100644 --- a/install/ubuntu-installation-guide.md +++ b/install/ubuntu-installation-guide.md @@ -1,9 +1,6 @@ # Installing Kata Containers on Ubuntu -> **Note:** Kata Containers is available for Ubuntu\* **16.04** and **17.10**. - -Currently Kata Containers is currently only build for x86_64. - +> **Note:** Kata Containers packages are available for Ubuntu\* **16.04** and **17.10** (currently `x86_64` only). This step is only required in case Docker is not installed on the system. 1. Install the latest version of Docker with the following commands: From 3e50bfc9ebeedacaa647f92b8010fa24725e0a3f Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Wed, 23 May 2018 14:28:51 +0100 Subject: [PATCH 3/4] docs: Add links to upgrade doc Update the install README and the install guides to point to the upgrading document. Fixes #119. Signed-off-by: James O. D. Hunt --- install/README.md | 1 + install/centos-installation-guide.md | 7 ++++++- install/fedora-installation-guide.md | 7 ++++++- install/ubuntu-installation-guide.md | 7 ++++++- 4 files changed, 19 insertions(+), 3 deletions(-) diff --git a/install/README.md b/install/README.md index 6efac4e395..02853108fc 100644 --- a/install/README.md +++ b/install/README.md @@ -8,5 +8,6 @@ Select your preferred distribution: For further information, see: +* The [the upgrading document](../Upgrading.md). * The [developer guide](https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md) * The [runtime documentation](https://github.com/kata-containers/runtime/blob/master/README.md) diff --git a/install/centos-installation-guide.md b/install/centos-installation-guide.md index 55d56d24f2..76da61db94 100644 --- a/install/centos-installation-guide.md +++ b/install/centos-installation-guide.md @@ -1,6 +1,11 @@ # Installing Kata Containers on CentOS -> **Note:** Kata Containers packages are available for CentOS version 7 (currently `x86_64` only). +> **Notes:** +> +> - Kata Containers packages are available for CentOS version 7 (currently `x86_64` only). +> +> - If you are installing on a system that already has Clear Containers or `runv` installed, +> first read [the upgrading document](../Upgrading.md). This step is only required in case Docker is not installed on the system. 1. Install the latest version of Docker with the following commands: diff --git a/install/fedora-installation-guide.md b/install/fedora-installation-guide.md index 699c1f95c6..ccedfb8e59 100644 --- a/install/fedora-installation-guide.md +++ b/install/fedora-installation-guide.md @@ -1,6 +1,11 @@ # Installing Kata Containers on Fedora -> **Note:** Kata Containers packages are available for Fedora\* versions **26** and **27** (currently `x86_64` only). +> **Notes:** +> +> - Kata Containers packages are available for Fedora\* versions **26** and **27** (currently `x86_64` only). +> +> - If you are installing on a system that already has Clear Containers or `runv` installed, +> first read [the upgrading document](../Upgrading.md). This step is only required in case Docker is not installed on the system. 1. Install the latest version of Docker with the following commands: diff --git a/install/ubuntu-installation-guide.md b/install/ubuntu-installation-guide.md index 43a6e102d2..2ea4561888 100644 --- a/install/ubuntu-installation-guide.md +++ b/install/ubuntu-installation-guide.md @@ -1,6 +1,11 @@ # Installing Kata Containers on Ubuntu -> **Note:** Kata Containers packages are available for Ubuntu\* **16.04** and **17.10** (currently `x86_64` only). +> **Notes:** +> +> - Kata Containers packages are available for Ubuntu\* **16.04** and **17.10** (currently `x86_64` only). +> +> - If you are installing on a system that already has Clear Containers or `runv` installed, +> first read [the upgrading document](../Upgrading.md). This step is only required in case Docker is not installed on the system. 1. Install the latest version of Docker with the following commands: From 28b94b72bf170b9f6b38d8838d002195424268bb Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Wed, 23 May 2018 14:35:53 +0100 Subject: [PATCH 4/4] docs: Add missing periods Add fullstops at the of bullets in install README. Signed-off-by: James O. D. Hunt --- install/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/install/README.md b/install/README.md index 02853108fc..d8479157b0 100644 --- a/install/README.md +++ b/install/README.md @@ -9,5 +9,5 @@ Select your preferred distribution: For further information, see: * The [the upgrading document](../Upgrading.md). -* The [developer guide](https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md) -* The [runtime documentation](https://github.com/kata-containers/runtime/blob/master/README.md) +* The [developer guide](https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md). +* The [runtime documentation](https://github.com/kata-containers/runtime/blob/master/README.md).