Merge pull request #418 from egernst/docs-cleanup

Docs cleanup

Limitations.md

@@ -138,7 +138,7 @@ these commands is potentially challenging.
 See issue https://github.com/clearcontainers/runtime/issues/341 and [the constraints challenge](#the-constraints-challenge) for more information.
 
 For CPUs resource management see
-[cpu-constraints](constraints/cpu.md).
+[cpu-constraints](design/cpu-constraints.md).
 
 ### docker run and shared memory
 

README.md

@@ -18,7 +18,7 @@ For details of the other Kata Containers repositories, see the
 [`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](zun/zun_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-cache-and-how-do-I-use-it.md) and [VM Cache](./how-to/what-is-vm-cache-and-how-do-I-use-it.md)
@@ -35,7 +35,7 @@ Documents that help to understand and contribute to Kata Containers.
 
 ### Design and Implementations
 
-* [Kata Containers Architecture](architecture.md): Architectural overview of Kata Containers
+* [Kata Containers Architecture](design/architecture.md): Architectural overview of Kata Containers
 * [Kata Containers design](./design/README.md): More Kata Containers design documents
 
 ### How to Contribute

Upgrading.md

@@ -142,7 +142,7 @@ standard package management tools for your distribution.
 
 Kata Containers requires additional resources to create a virtual machine
 container. These resources are called
-[Kata Containers assets](https://github.com/kata-containers/documentation/blob/master/architecture.md#assets),
+[Kata Containers assets](./design/architecture.md#assets),
 which comprise a guest kernel and a root filesystem or initrd image. This
 section describes when these components are updated.
 

design/README.md

@@ -2,7 +2,7 @@
 
 Kata Containers design documentations, include the 
 
-- [Kata Containers architecture](../architecture.md)
+- [Kata Containers architecture](architecture.md)
 - Working scenarios of Kata Containers
 - [API Design of Kata Containers](kata-api-design.md)
 - Kata Containers lifecycle

design/VSocks.md

@@ -130,5 +130,5 @@ the containers are removed automatically.
 [2]: https://github.com/kata-containers/proxy
 [3]: https://github.com/hashicorp/yamux
 [4]: https://wiki.qemu.org/Features/VirtioVsock
-[5]: https://github.com/kata-containers/documentation/blob/master/constraints/cpu.md#virtual-cpus-and-kubernetes-pods
+[5]: ./cpu-constraints.md#virtual-cpus-and-kubernetes-pods
 [6]: https://github.com/kata-containers/shim

design/architecture.md

@@ -544,8 +544,7 @@ dedicated master node) calls into a compute kubelet. This kubelet instance is
 responsible for managing the lifecycle of pods within the nodes and eventually relies
 on a container runtime to handle execution. The kubelet architecture decouples
 lifecycle management from container execution through the dedicated
-[`gRPC`](https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/apis/cri/runtime/v1alpha2/api.proto)
-based [Container Runtime Interface (CRI)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/node/container-runtime-interface-v1.md).
+`gRPC` based [Container Runtime Interface (CRI)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/node/container-runtime-interface-v1.md).
 
 In other words, a kubelet is a CRI client and expects a CRI implementation to
 handle the server side of the interface.

use-cases/zun_kata.md

@@ -101,22 +101,22 @@ sudo systemctl daemon-reload
 sudo systemctl restart docker
 ```
 
-![kata zun image 1](kata-zun1.png)
+![kata zun image 1](./images/kata-zun1.png)
 
 Figure 1: Create a busybox container image
 
-![kata zun image 2](kata-zun2.png)
+![kata zun image 2](./images/kata-zun2.png)
 
 Figure 2: Select `kata-runtime` to use
 
-![kata zun image 3](kata-zun3.png)
+![kata zun image 3](./images/kata-zun3.png)
 
 Figure 3: Two busybox containers successfully launched
 
-![kata zun image 4](kata-zun4.png)
+![kata zun image 4](./images/kata-zun4.png)
 
 Figure 4: Test connectivity between Kata Containers
 
-![kata zun image 5](kata-zun5.png)
+![kata zun image 5](./images/kata-zun5.png)
 
 Figure 5: CLI for Zun