From 54be6c69d1620898a0ecfd4cbcf5e0ecfb01b599 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Mon, 21 May 2018 10:48:54 +0100 Subject: [PATCH 1/3] docs: Add bullets to install README Format the list of install guides as a bullet list in the installation README. Signed-off-by: James O. D. Hunt --- install/README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/install/README.md b/install/README.md index 31f3de220f..9746e1a253 100644 --- a/install/README.md +++ b/install/README.md @@ -1,5 +1,4 @@ # Kata Containers installation user guides -[Fedora](https://github.com/kata-containers/documentation/blob/master/install/fedora-installation-guide.md) - -[Ubuntu](https://github.com/kata-containers/documentation/blob/master/install/ubuntu-installation-guide.md) +* [Fedora](https://github.com/kata-containers/documentation/blob/master/install/fedora-installation-guide.md) +* [Ubuntu](https://github.com/kata-containers/documentation/blob/master/install/ubuntu-installation-guide.md) From 9d37c48088fd89d2d6754c6e6e0160c20194a17f Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Mon, 21 May 2018 10:51:51 +0100 Subject: [PATCH 2/3] docs: Add detail to install README Add a sentence introducing the install guides in the installation README. Signed-off-by: James O. D. Hunt --- install/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/install/README.md b/install/README.md index 9746e1a253..6642611259 100644 --- a/install/README.md +++ b/install/README.md @@ -1,4 +1,6 @@ # Kata Containers installation user guides +Select your preferred distribution: + * [Fedora](https://github.com/kata-containers/documentation/blob/master/install/fedora-installation-guide.md) * [Ubuntu](https://github.com/kata-containers/documentation/blob/master/install/ubuntu-installation-guide.md) From 08288d98088c89a3f03fbd8af0f1aaeef54d70f3 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Mon, 21 May 2018 10:51:58 +0100 Subject: [PATCH 3/3] docs: Add further links to install README Add developer guide and runtime repo links to the installation README. Fixes #105. Signed-off-by: James O. D. Hunt --- install/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/install/README.md b/install/README.md index 6642611259..0f67a0e223 100644 --- a/install/README.md +++ b/install/README.md @@ -4,3 +4,8 @@ Select your preferred distribution: * [Fedora](https://github.com/kata-containers/documentation/blob/master/install/fedora-installation-guide.md) * [Ubuntu](https://github.com/kata-containers/documentation/blob/master/install/ubuntu-installation-guide.md) + +For further information, see: + +* 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)