Commit Graph

11 Commits

Author SHA1 Message Date
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 #7 was merged inadvertently, so apply the Documentation Team's
review comments to `README.md`.

Fixes #10.

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 #6.

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 #3.

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 #1.

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