From 4f164da00f23ad16d8cb4b4b4b613c44560f0919 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 16 May 2019 11:23:42 +0100 Subject: [PATCH] docs: Clean up how-to handling - Created a how-to README. - Moved howto links in top-level README to the how-to README. - Moved svc-mesh how to into the how-to directory. Fixes #473. Signed-off-by: James O. D. Hunt --- README.md | 13 ++++++------- how-to/README.md | 10 ++++++++++ {svc-mesh => how-to}/service-mesh.md | 0 3 files changed, 16 insertions(+), 7 deletions(-) create mode 100644 how-to/README.md rename {svc-mesh => how-to}/service-mesh.md (100%) diff --git a/README.md b/README.md index d0df34ef0..abbc50ded 100644 --- a/README.md +++ b/README.md @@ -27,17 +27,16 @@ For details of the other Kata Containers repositories, see the * [Limitations](Limitations.md): differences and limitations compared with the default [Docker](https://www.docker.com/) runtime, [`runc`](https://github.com/opencontainers/runc). -* HOWTO: [Kata Containers with k8s and cri-containerd](./how-to/how-to-use-k8s-with-cri-containerd-and-kata.md) -* HOWTO: [OpenStack Zun with Kata Containers](./use-cases/zun_kata.md) -* HOWTO: [Kata Containers with Firecracker](https://github.com/kata-containers/documentation/wiki/Initial-release-of-Kata-Containers-with-Firecracker-support) -* HOWTO: [Sysctls with Kata Containers](./how-to/how-to-use-sysctls-with-kata.md) -* HOWTO: [VM Templating](./how-to/what-is-vm-templating-and-how-do-I-use-it.md) and [VM Cache](./how-to/what-is-vm-cache-and-how-do-I-use-it.md) +### Howto guides + +See the [howto documentation](how-to). ## Kata Use-Cases -* [VPP with Kata](./use-cases/using-vpp-and-kata.md) -* [SR-IOV with Kata](./use-cases/using-SRIOV-and-kata.md) * [GPU Passthrough with Kata](./use-cases/GPU-passthrough-and-Kata.md) +* [OpenStack Zun with Kata Containers](./use-cases/zun_kata.md) +* [SR-IOV with Kata](./use-cases/using-SRIOV-and-kata.md) +* [VPP with Kata](./use-cases/using-vpp-and-kata.md) ## Developer Guide diff --git a/how-to/README.md b/how-to/README.md new file mode 100644 index 000000000..e0fac4a2f --- /dev/null +++ b/how-to/README.md @@ -0,0 +1,10 @@ +# Howto guides + +- [How to use Kata Containers and Containerd](containerd-kata.md) +- [How to use Kata Containers and CRI (containerd plugin) with Kubernetes](how-to-use-k8s-with-cri-containerd-and-kata.md) +- [Kata Containers and service mesh for Kubernetes](service-mesh.md) +- [Kata Containers with Firecracker](https://github.com/kata-containers/documentation/wiki/Initial-release-of-Kata-Containers-with-Firecracker-support) +- [Kata Containers with NEMU](how-to-use-kata-containers-with-nemu.md) +- [Setting Sysctls with Kata](how-to-use-sysctls-with-kata.md) +- [What Is VMCache and How To Enable It](what-is-vm-cache-and-how-do-I-use-it.md) +- [What Is VM Templating and How To Enable It](what-is-vm-templating-and-how-do-I-use-it.md) diff --git a/svc-mesh/service-mesh.md b/how-to/service-mesh.md similarity index 100% rename from svc-mesh/service-mesh.md rename to how-to/service-mesh.md