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) 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)