mirror of https://github.com/kata-containers/kata-containers.git synced 2025-09-02 09:24:35 +00:00

Go to file

James O. D. Hunt ce85eb2ccd docs: Add warnings to doc requirements doc

Document how other admonitions such as warnings and hints should be
handled.

Fixes #307.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>

2018-11-21 10:36:56 +00:00

.ci

CI: Test remaining install methods

2018-10-25 16:28:22 +01:00

arch-images

uml: add txt source of network hotplug uml

2018-09-25 15:24:14 +08:00

constraints

constraints: document CPU constraints

2018-06-04 09:51:19 -05:00

design

api: update kata api design doc

2018-09-25 15:24:14 +08:00

how-to

nemu: Retrieve directly the latest OVMF binary

2018-11-01 09:19:24 -07:00

install

Merge pull request #272 from raravena80/master

2018-10-26 04:51:14 +01:00

svc-mesh

docs: svc-mesh: Create some documentation about service mesh

2018-06-22 15:41:01 -07:00

use-cases

use-cases: Add documentation for using Intel GPU with Kata

2018-10-08 10:20:24 -07:00

zun

Zun: Move to subdir and add to README

2018-06-12 10:36:45 +01:00

.pullapprove.yml

CI: Require doc team signoff for doc changes

2018-01-24 13:42:26 +00:00

.travis.yml

CI: Pin Travis golang version

2018-10-23 17:25:20 +01:00

architecture.md

Merge pull request #293 from liucimin/update_architecture_docs

2018-11-16 15:53:05 +00:00

CODE_OF_CONDUCT.md

docs: Add code of conduct doc

2018-02-06 10:39:00 +00:00

CONTRIBUTING.md

cs : Add minimal contribution guidelines

2018-01-30 22:14:52 +05:30

Developer-Guide.md

Developer-Guide: Update kernel installation doc

2018-10-14 16:15:33 +05:30

Documentation-Requirements.md

docs: Add warnings to doc requirements doc

2018-11-21 10:36:56 +00:00

LICENSE

Initial commit

2017-12-21 13:41:45 +00:00

Licensing-strategy.md

docs: Add license strategy doc

2018-04-19 17:40:03 +01:00

Limitations.md

docs: Remove Ramdisk Limitations

2018-11-08 02:16:04 -06:00

Makefile

CI: Pin Travis golang version

2018-10-23 17:25:20 +01:00

README.md

README.md: update the README of the documentation repo

2018-09-12 16:41:47 +08:00

Release-Checklist.md

checklist: add snap packages to the release checklist

2018-09-28 09:32:26 -05:00

Releases.md

docs: Fix release checklist link in releases doc

2018-05-14 16:27:43 +01:00

Stable-Branch-Strategy.md

stable: initial stable-branching documentation

2018-09-18 07:25:10 -07:00

Upgrading.md

docs: Remove throttler in upgrading doc

2018-06-05 17:21:03 +08:00

VSocks.md

usecases: add vsock documentation

2018-08-22 09:27:19 -05:00

README.md

Documentation

The Kata Containers documentation repository hosts overall system documentation, with information common to multiple components.

For details of the other Kata Containers repositories, see the repository summary.

Getting Started

Installation guides: Install and run Kata Containers with Docker or Kubernetes

More User Guides

Upgrading: how to upgrade from Clear Containers and runV to Kata Containers and how to upgrade an existing Kata Containers system to the latest version.
Limitations: differences and limitations compared with the default Docker runtime, runc.
HOWTO: Kata Containers with k8s and cri-containerd
HOWTO: OpenStack Zun with Kata Containers

Developer Guide

Documents that help to understand and contribute to Kata Containers.

Design and Implementations

Kata Containers Architecture: Architectural overview of Kata Containers
Kata Containers design: More Kata Containers design documents

How to Contribute

Developer Guide: Setup the Kata Containers developing environments
How to contribute to Kata Containers
Code of Conduct

Code Licensing

Licensing: About the licensing strategy of Kata Containers.

The Release Process

Help Improving the Documents

Documentation Requirements

Languages

Rust 58%

Go 24.6%

Shell 10.1%

RPC 5.3%

Makefile 1%

Other 0.9%