From 11c3d81f68efb19ed47059b0654d1f7a07a25c22 Mon Sep 17 00:00:00 2001 From: Salvador Fuentes Date: Wed, 29 Apr 2020 17:51:44 -0500 Subject: [PATCH] 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 --- README.md | 2 +- tools/osbuilder/CODE_OF_CONDUCT.md | 3 --- tools/osbuilder/CONTRIBUTING.md | 5 ----- tools/osbuilder/image-builder/README.md | 2 +- 4 files changed, 2 insertions(+), 10 deletions(-) delete mode 100644 tools/osbuilder/CODE_OF_CONDUCT.md delete mode 100644 tools/osbuilder/CONTRIBUTING.md diff --git a/README.md b/README.md index cc82336c8f..fc382365ba 100644 --- a/README.md +++ b/README.md @@ -128,7 +128,7 @@ as the component it tests). #### 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 the environment before switching to the workload. diff --git a/tools/osbuilder/CODE_OF_CONDUCT.md b/tools/osbuilder/CODE_OF_CONDUCT.md deleted file mode 100644 index d73eb8f46e..0000000000 --- a/tools/osbuilder/CODE_OF_CONDUCT.md +++ /dev/null @@ -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/). diff --git a/tools/osbuilder/CONTRIBUTING.md b/tools/osbuilder/CONTRIBUTING.md deleted file mode 100644 index 8a3af744a6..0000000000 --- a/tools/osbuilder/CONTRIBUTING.md +++ /dev/null @@ -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). \ No newline at end of file diff --git a/tools/osbuilder/image-builder/README.md b/tools/osbuilder/image-builder/README.md index acfa24e20b..87ebe125ae 100644 --- a/tools/osbuilder/image-builder/README.md +++ b/tools/osbuilder/image-builder/README.md @@ -17,7 +17,7 @@ $ sudo ./image_builder.sh path/to/rootfs Where `path/to/rootfs` is the directory populated by `rootfs.sh`. > **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