From 60823abb9c7f46c0eee610a00cdf878d6abbbb68 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 26 May 2022 13:44:20 +0100 Subject: [PATCH] docs: Move snap README Move the snap README to a subdirectory to resolve the warning given by `snapcraft` (folded and reformatted slightly for clarity): ``` The 'snap' directory is meant specifically for snapcraft, but it contains the following non-snapcraft-related paths, which is unsupported and will cause unexpected behavior: - README.md If you must store these files within the 'snap' directory, move them to 'snap/local', which is ignored by snapcraft. ``` Signed-off-by: James O. D. Hunt --- README.md | 2 +- snap/{ => local}/README.md | 10 +++++----- tools/packaging/README.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) rename snap/{ => local}/README.md (89%) diff --git a/README.md b/README.md index 3cac624006..90a5c9209a 100644 --- a/README.md +++ b/README.md @@ -140,7 +140,7 @@ The table below lists the remaining parts of the project: Kata Containers is now [available natively for most distributions](docs/install/README.md#packaged-installation-methods). -However, packaging scripts and metadata are still used to generate snap and GitHub releases. See +However, packaging scripts and metadata are still used to generate [snap](snap/local) and GitHub releases. See the [components](#components) section for further details. ## Glossary of Terms diff --git a/snap/README.md b/snap/local/README.md similarity index 89% rename from snap/README.md rename to snap/local/README.md index 3729542ecd..95eef59fb2 100644 --- a/snap/README.md +++ b/snap/local/README.md @@ -76,12 +76,12 @@ then a new configuration file can be [created](#configure-kata-containers) and [configured][7]. [1]: https://docs.snapcraft.io/snaps/intro -[2]: ../docs/design/architecture/README.md#root-filesystem-image +[2]: ../../docs/design/architecture/README.md#root-filesystem-image [3]: https://docs.snapcraft.io/reference/confinement#classic [4]: https://github.com/kata-containers/runtime#configuration [5]: https://docs.docker.com/engine/reference/commandline/dockerd -[6]: ../docs/install/docker/ubuntu-docker-install.md -[7]: ../docs/Developer-Guide.md#configure-to-use-initrd-or-rootfs-image +[6]: ../../docs/install/docker/ubuntu-docker-install.md +[7]: ../../docs/Developer-Guide.md#configure-to-use-initrd-or-rootfs-image [8]: https://snapcraft.io/kata-containers -[9]: ../docs/Developer-Guide.md#run-kata-containers-with-docker -[10]: ../docs/Developer-Guide.md#run-kata-containers-with-kubernetes +[9]: ../../docs/Developer-Guide.md#run-kata-containers-with-docker +[10]: ../../docs/Developer-Guide.md#run-kata-containers-with-kubernetes diff --git a/tools/packaging/README.md b/tools/packaging/README.md index 19d0978d49..8a31c0a80f 100644 --- a/tools/packaging/README.md +++ b/tools/packaging/README.md @@ -14,7 +14,7 @@ running Kubernetes Cluster very straightforward. ## Build a snap package -See [the snap documentation](../../snap). +See [the snap documentation](../../snap/local). ## Build static binaries