github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-04-30 04:34:27 +00:00
Code Issues Projects Releases Wiki Activity

docs: Move snap README

Browse Source 
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 <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2022-05-26 13:44:20 +01:00
parent 4134beee39
commit 60823abb9c
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -140,7 +140,7 @@ The table below lists the remaining parts of the project:
Kata Containers is now Kata Containers is now
[available natively for most distributions](docs/install/README.md#packaged-installation-methods). [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. the [components](#components) section for further details.
## Glossary of Terms ## Glossary of Terms

10
snap/README.md → snap/local/README.md
View File

@ -76,12 +76,12 @@ then a new configuration file can be [created](#configure-kata-containers)
and [configured][7]. and [configured][7].
[1]: https://docs.snapcraft.io/snaps/intro [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 [3]: https://docs.snapcraft.io/reference/confinement#classic
[4]: https://github.com/kata-containers/runtime#configuration [4]: https://github.com/kata-containers/runtime#configuration
[5]: https://docs.docker.com/engine/reference/commandline/dockerd [5]: https://docs.docker.com/engine/reference/commandline/dockerd
[6]: ../docs/install/docker/ubuntu-docker-install.md [6]: ../../docs/install/docker/ubuntu-docker-install.md
[7]: ../docs/Developer-Guide.md#configure-to-use-initrd-or-rootfs-image [7]: ../../docs/Developer-Guide.md#configure-to-use-initrd-or-rootfs-image
[8]: https://snapcraft.io/kata-containers [8]: https://snapcraft.io/kata-containers
[9]: ../docs/Developer-Guide.md#run-kata-containers-with-docker [9]: ../../docs/Developer-Guide.md#run-kata-containers-with-docker
[10]: ../docs/Developer-Guide.md#run-kata-containers-with-kubernetes [10]: ../../docs/Developer-Guide.md#run-kata-containers-with-kubernetes

2
tools/packaging/README.md
View File

@ -14,7 +14,7 @@ running Kubernetes Cluster very straightforward.
## Build a snap package ## Build a snap package
See [the snap documentation](../../snap). See [the snap documentation](../../snap/local).
## Build static binaries ## Build static binaries