github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-28 20:41:04 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #245 from gnawux/readme-organize

Browse Source 
README.md: update the README of the documentation repo
This commit is contained in:
Eric Ernst 2018-09-13 15:17:45 -04:00 committed by GitHub
commit 209433c799
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 37 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -7,17 +7,43 @@ 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)
## Getting Started
* [Installation guides](./install/README.md): Install and run Kata Containers with Docker or Kubernetes
## More User Guides
* [Upgrading](Upgrading.md): how to upgrade from [Clear Containers](https://github.com/clearcontainers) and [runV](https://github.com/hyperhq/runv) to [Kata Containers](https://github.com/kata-containers) and how to upgrade an existing Kata Containers system to the latest version.
* [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](zun/zun_kata.md)
## Developer Guide
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 design](./design/README.md): More Kata Containers design documents
### How to Contribute
* [Developer Guide](Developer-Guide.md): Setup the Kata Containers developing environments
* [How to contribute to Kata Containers](https://github.com/kata-containers/community/blob/master/CONTRIBUTING.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)
### Code Licensing
* [Licensing](Licensing-strategy.md): About the licensing strategy of Kata Containers.
### The Release Process
* [Release strategy](Releases.md)
* [Release Checklist](Release-Checklist.md)
* [Upgrading](Upgrading.md)
* [OpenStack Zun with Kata Containers](zun/zun_kata.md)
## Help Improving the Documents
* [Documentation Requirements](Documentation-Requirements.md)