From 63776a197af29e86864a5b19cb8c0dd70ef87e8e Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 18 Apr 2019 16:00:17 +0100 Subject: [PATCH] docs: Fix markdown Resolve issues in the markdown files in this repo. Fixes #435. Signed-off-by: James O. D. Hunt --- kata-deploy/README.md | 4 ++-- release/release.md | 4 ++-- snap/README.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/kata-deploy/README.md b/kata-deploy/README.md index 55954ed41b..be17477249 100644 --- a/kata-deploy/README.md +++ b/kata-deploy/README.md @@ -15,7 +15,7 @@ - [Kata deploy](#kata-deploy) - [Kata cleanup](#kata-cleanup) -[kata-deploy](kata-deploy) provides a Dockerfile, which contains all of the binaries +[kata-deploy](.) provides a Dockerfile, which contains all of the binaries and artifacts required to run Kata Containers, as well as reference daemonsets, which can be utilized to install Kata Containers for both Docker and on a running Kubernetes cluster. @@ -128,7 +128,7 @@ kubectl delete -f kata-rbac.yaml ### Dockerfile -The [Dockerfile](kata-deploy/Dockerfile) used to create the container image deployed in the DaemonSet is provided here. +The [Dockerfile](Dockerfile) used to create the container image deployed in the DaemonSet is provided here. This image contains all the necessary artifacts for running Kata Containers, all of which are pulled from the [Kata Containers release page](https://github.com/kata-containers/runtime/releases). diff --git a/release/release.md b/release/release.md index 3a3e14aff9..65678ad201 100644 --- a/release/release.md +++ b/release/release.md @@ -1,7 +1,7 @@ # How to do a Kata Containers Release -* [Introduction](#Introduction) -* [Requirements](#Requirements) +* [Introduction](#introduction) +* [Requirements](#requirements) * [Release process](#release-process) # Introduction diff --git a/snap/README.md b/snap/README.md index 7a1a3a4150..5a2a567cd8 100644 --- a/snap/README.md +++ b/snap/README.md @@ -70,7 +70,7 @@ The [miniOS image][2] is not included in the snap image as it is not possible fo QEMU to open a guest RAM backing store on a read-only filesystem. Fortunately, you can start Kata Containers with a Linux initial RAM disk (initrd) that is included in the snap image. If you want to use the miniOS image instead of initrd, -then a new configuration file can be [created](#configuring-kata-containers) +then a new configuration file can be [created](#configure-kata-containers) and [configured][7]. [1]: https://docs.snapcraft.io/snaps/intro