github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-08 03:24:15 +00:00
Code Issues Projects Releases Wiki Activity

docs: fix markdown check issues

Browse Source 
- 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>
This commit is contained in:
Salvador Fuentes 2020-04-29 17:51:44 -05:00
parent 21c830c7da
commit 11c3d81f68
4 changed files with 2 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -128,7 +128,7 @@ as the component it tests).
#### OS builder #### OS builder
The [osbuilder](https://github.com/kata-containers/osbuilder) tool can create The [osbuilder](tools/osbuilder/README.md) tool can create
a rootfs and a "mini O/S" image. This image is used by the hypervisor to setup a rootfs and a "mini O/S" image. This image is used by the hypervisor to setup
the environment before switching to the workload. the environment before switching to the workload.

3
tools/osbuilder/CODE_OF_CONDUCT.md
View File

@ -1,3 +0,0 @@
## Kata Containers osbuilder Code of Conduct
Kata Containers follows the [OpenStack Foundation Code of Conduct](https://www.openstack.org/legal/community-code-of-conduct/).

5
tools/osbuilder/CONTRIBUTING.md
View File

@ -1,5 +0,0 @@
# Contributing
## This repo is part of [Kata Containers](https://katacontainers.io)
For details on how to contribute to the Kata Containers project, please see the main [contributing document](https://github.com/kata-containers/community/blob/master/CONTRIBUTING.md).

2
tools/osbuilder/image-builder/README.md
View File

@ -17,7 +17,7 @@ $ sudo ./image_builder.sh path/to/rootfs
Where `path/to/rootfs` is the directory populated by `rootfs.sh`. Where `path/to/rootfs` is the directory populated by `rootfs.sh`.
> **Note**: If you are building an image from an Alpine rootfs, see > **Note**: If you are building an image from an Alpine rootfs, see
> the important note [here](/rootfs-builder/README.md#rootfs-requirements). > the important note [here](/tools/osbuilder/rootfs-builder/README.md#rootfs-requirements).
## Further information ## Further information