From 1dd26540bc04108e3536cf4829e608565483e307 Mon Sep 17 00:00:00 2001 From: Graham Whaley Date: Fri, 8 Jun 2018 11:24:14 +0100 Subject: [PATCH 1/2] README: Add all docs to the index The top level README.md index for the repository was a bit slim on entries. Add all the other docs in this repo to the index, and sort them alphabetically by symbolic name (which may be slightly different from the filename itself). Fixes: #146 Signed-off-by: Graham Whaley --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index f8402deebb..515a3e64ac 100644 --- a/README.md +++ b/README.md @@ -7,5 +7,16 @@ common to multiple components. For details of the other Kata Containers repositories, see the [repository summary](https://github.com/kata-containers/kata-containers). +* [Kata Containers Architecture](architecture.md) * [Developer Guide](Developer-Guide.md) +* [Code of Conduct](CODE_OF_CONDUCT.md) +* [Contributing](CONTRIBUTING.md) +* [Kata Containers design](./design/README.md) +* [Documentation Requirements](Documentation-Requirements.md) +* [Installation guides](./install/README.md) +* [Kata Containers with k8s and cri-containerd](./how-to/how-to-use-k8s-with-cri-containerd-and-kata.md) +* [Licensing](Licensing-strategy.md) * [Limitations](Limitations.md) +* [Release strategy](Releases.md) +* [Release Checklist](Release-Checklist.md) +* [Upgrading](Upgrading.md) From 86b33afb7c8687c7b98868ba496ff8e59c2ee988 Mon Sep 17 00:00:00 2001 From: Graham Whaley Date: Fri, 8 Jun 2018 11:43:33 +0100 Subject: [PATCH 2/2] design: Update the index and add some links The design subdir README index was a little slim and potentially out of date, and was missing hotlinks to some documents that did exist. Signed-off-by: Graham Whaley --- design/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/design/README.md b/design/README.md index 6d8a36d04a..6c4bb32897 100644 --- a/design/README.md +++ b/design/README.md @@ -2,7 +2,8 @@ Kata Containers design documentations, include the -- Kata Containers architecture +- [Kata Containers architecture](../architecture.md) - Working scenarios of Kata Containers -- API Design of Kata Containers +- [API Design of Kata Containers](kata-api-design.md) - Kata Containers lifecycle +- [Design requirements for Kata Containers](kata-design-requirements.md)