kata-containers/docs
Hui Zhu 17af28acad docs: Add how-to-use-memory-agent.md to howto
Add how-to-use-memory-agent.md (How to use mem-agent to decrease the
memory usage of Kata container) to docs to show how to use mem-agent.

Fixes: #11013

Signed-off-by: Hui Zhu <teawater@gmail.com>
2025-04-02 17:45:59 +08:00
..
design osbuilder: Drop Clear Linux 2024-11-11 15:22:55 +01:00
how-to docs: Add how-to-use-memory-agent.md to howto 2025-04-02 17:45:59 +08:00
install docs: replace egrep/fgrep with grep -E/-F to avoid deprecation warning 2025-01-29 11:25:54 +01:00
presentations docs: Remove jenkins reference from unit testing presentation 2024-07-01 20:26:35 +00:00
threat-model docs: Format the threat-model to 80 chars 2024-05-28 07:39:26 +00:00
use-cases docs: replace egrep/fgrep with grep -E/-F to avoid deprecation warning 2025-01-29 11:25:54 +01:00
Blog-Post-Submission-Guide.md docs: Adding blog submission guidelines 2024-06-03 08:58:05 -07:00
code-pr-advice.md docs: Remove links to tests repo 2024-03-25 15:09:52 -07:00
Debug-shim-guide.md debugging: adding a script and instructions for debugging the GO shim 2024-05-14 11:12:31 +02:00
Developer-Guide.md docs: replace egrep/fgrep with grep -E/-F to avoid deprecation warning 2025-01-29 11:25:54 +01:00
Documentation-Requirements.md docs: Update links in the Documentation Requirements document 2024-03-20 15:45:49 +00:00
hypervisors.md docs: Fix qemu link 2024-09-19 16:05:43 +02:00
Licensing-strategy.md docs: Change location of static checks script 2023-12-15 17:13:02 -08:00
Limitations.md doc: add vcpu handlint doc for runtime-rs 2023-06-12 19:23:11 +08:00
Makefile docs: merge documentation repository 2020-06-23 21:27:23 -07:00
README.md docs: Adding blog submission guidelines 2024-06-03 08:58:05 -07:00
Release-Process.md doc: Update the release process 2024-12-19 09:52:39 +00:00
tracing.md docs: Fix relative links in Markdown 2022-02-11 13:49:42 +01:00
Unit-Test-Advice.md docs: Specify language in markdown for syntax highlight 2022-09-01 13:54:31 +08:00
Upgrading.md docs: Adjust release documentation 2024-03-27 12:41:48 +01:00

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

Tracing

See the tracing documentation.

More User Guides

How-to guides

See the how-to documentation.

Kata Use-Cases

Developer Guide

Documents that help to understand and contribute to Kata Containers.

Design and Implementations

How to Contribute

Help Writing a Code PR

Help Writing Unit Tests

Help Improving the Documents

Code Licensing

  • Licensing: About the licensing strategy of Kata Containers.

The Release Process

Presentations

Website Changes

If you have a suggestion for how we can improve the website, please raise an issue (or a PR) on the repository that holds the source for the website.