1
0
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-05-11 09:55:58 +00:00
Commit Graph

24 Commits

Author SHA1 Message Date
Peng Tao
7c4263b3e1 src: reorg source directories
To make the code directory structure more clear:

└── src
    ├── agent
    ├── libs
    │   └── logging
    ├── runtime
    ├── runtime-rs (to be added)
    └── tools
        ├── agent-ctl
        └── trace-forwarder

Fixes: 
Signed-off-by: Peng Tao <bergwolf@hyper.sh>
2021-12-14 10:30:08 +08:00
James O. D. Hunt
57b696a5ec docs: Removed mention of 1.x
All users should be running 2.x releases so remove the legacy details
since it's arguably confusing to have two sets of details.

Reworked the components listed in the main README so that rather than
being sorted alphabetically, they are now sorted in semi-order of
importance and split into two tables to make the point more clearly.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2021-07-30 10:58:22 +01:00
James O. D. Hunt
4f0726bc49 docs: Remove table of contents
Removed all TOCs now that GitHub auto-generates them.

Also updated the documentation requirements doc removing the requirement
to add a TOC.

Fixes: .

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2021-07-30 10:58:22 +01:00
James O. D. Hunt
f186c5e284 docs: Fix invalid URLs
Correct broken / stale URLs as detected by the CI URL checker.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2021-07-30 10:58:22 +01:00
hspease99
f7c6f17060 docs: added a glossary to support SEO tactics
This commit is a result of Assisted PR Process for PR .  It
deviates from it in that the original commits were not retained as the
original commit structure was unnecessarily complex - the same commit
was added to two parallel branches which were then merged, producing the
same result in the end as any of the original two non-merge commits.
Also, a squash was requested by an original PR review.

Other changes to the original PR were changing capitalisation of the word
"Kubelet" in Glossary.md to placate spell checker and fixing link names and
syntax.

The original commit message follows:

The terms added are: Kata Containers, container software, container
runtime interface, virtual machine software, container virtualization,
container security solutions, serverless containers, pod containers,
virtual machine monitor, private cloud, infrastructure architecture,
public cloud, and auto scaling.

Fixes: 

Signed-off-by: Helena Spease <helena@openstack.org>
Signed-off-by: Pavel Mores <pmores@redhat.com>
2021-07-20 11:22:58 +02:00
Peng Tao
fd5592d4d5 branch: change 2.0-dev to main
Change all mentioning of 2.0-dev to main so that we can rename the
default branch to main.

Fixes: 
Signed-off-by: Peng Tao <bergwolf@hyper.sh>
2021-01-22 15:49:35 +08:00
Eric Ernst
e684a54163 docs: add link to VMT on top level README
The VMT process is well documented, but users would need to land on
community repo to find it. Let's make it easier to identify the correct
way to disclose vulnerabilities.

Fixes: 

Signed-off-by: Eric Ernst <eric.g.ernst@gmail.com>
2020-11-30 08:12:31 -08:00
James O. D. Hunt
62c7e09405 docs: Remove credits
Removed the packagecloud credits since we no longer produce distro
packages for Kata 2.x.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2020-11-03 11:38:59 +00:00
James O. D. Hunt
679df0fb77 docs: Update top-level README
Rework the top-level README to reflect the current use of this
repository.

Fixes: .

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2020-11-03 11:38:57 +00:00
Archana Shinde
d64641174e docs: Update Readme to remove hypervisor information
The repo https://github.com/kata-containers/qemu has been
archived. We should remove this, as this is not the only
hypervisor we support now.

Signed-off-by: Archana Shinde <archana.m.shinde@intel.com>
2020-10-19 14:03:57 -07:00
bin liu
d7f75dce83 docs: remove shim/proxy topics and fix docs links
And also change links from old documentation to docs sub-directory.

Fixes 

Signed-off-by: bin liu <bin@hyper.sh>
2020-07-24 17:53:38 +08:00
Peng Tao
e29546016e readme: fix reference to packaging tools
As we have merged it here.

Signed-off-by: Peng Tao <bergwolf@hyper.sh>
2020-06-24 03:32:15 -07:00
Peng Tao
f818b46a41 readme: fix documentation reference link
Now it is inside the docs directory.

Signed-off-by: Peng Tao <bergwolf@hyper.sh>
2020-06-23 21:27:56 -07:00
James O. D. Hunt
48d3471cfe docs: Add trace forwarder doc reference
Add a pointer to the trace forwarder README to the top-level README.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2020-06-09 09:55:48 +01:00
James O. D. Hunt
2e97fbfdc0 docs: Reference kata-agent-ctl doc
Add a link to the `kata-agent-ctl` README.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2020-06-08 11:22:19 +01:00
Salvador Fuentes
11c3d81f68 docs: fix markdown check issues
- Removes `CODE_OF_CONDUCT.md` and `CONTRIBUTING.md` from osbuilder
directory.
- Fixes a reference from `image-builder/README.md` to
`rootfs-builder/README.md`
- Updates the main `README.md` making a reference to the local
`tools/osbuilder/README.md`

Signed-off-by: Salvador Fuentes <salvador.fuentes@intel.com>
2020-04-29 17:51:44 -05:00
Peng Tao
4fceb03d96 markdown: fix markdown checke failures
Pass markdown checker.

Signed-off-by: Peng Tao <bergwolf@hyper.sh>
2020-04-27 19:50:59 -07:00
Thierry Carrez
403fb4c5b0 Credit packagecloud for package hosting
We use a packagecloud OSS account for package hosting.
As part of the arrangement with packagecloud we need to
credit them and add a link back to https://packagecloud.io
on our website and project README.

This repository's README is probably the closest we have to
a "project README", so let's add it here.

Signed-off-by: Thierry Carrez <thierry@openstack.org>
2019-03-15 10:08:22 +01:00
James O. D. Hunt
a390027452 docs: Apply doc team review comments to README
PR  was merged inadvertently, so apply the Documentation Team's
review comments to `README.md`.

Fixes .

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-02-05 09:49:12 +00:00
James O. D. Hunt
d524e7adf5 docs: Add references to "ci" and "packaging" repos
Add brief details of the new "ci" and "packaging" repositories.

Fixes .

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-02-02 10:16:34 +00:00
James O. D. Hunt
09373bd2b4 docs: Fix anchor for osbuilder
The HTML anchor generated by github for "osbuilder" wasn't working, so
removed the slash from the title.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-02-02 10:16:34 +00:00
James O. D. Hunt
98844e931e docs: Remove unecessary backticks
Remove backticks from repos that are not the name of files/commands.

Also, mark first instance of "Linux" with asterisk.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-02-02 09:42:31 +00:00
James O. D. Hunt
3954152692 docs: Fix README TOC formatting
Fixed incorrect indentation for the README's table of contents.

Also, sorted alphabetically.

Fixes .

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-01-26 17:56:07 +00:00
James O. D. Hunt
b2c26cb63c docs: Add README
Add a `README.md` that explains the purpose of this repository along
with pointers to the other repositories.

Fixes .

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-01-26 14:13:45 +00:00