Skip to content
This repository has been archived by the owner on May 12, 2021. It is now read-only.

docs: Fix spelling and formatting #542

Merged
merged 1 commit into from May 28, 2019

Conversation

jodh-intel
Copy link
Contributor

Correct typos and resolve formatting issues including incorrect heading levels and missing TOC entries.

Fixes: #541.

Signed-off-by: James O. D. Hunt james.o.hunt@intel.com



### Install Kata and configure Docker

To install:

```
docker run -v /opt/kata:/opt/kata -v /var/run/dbus:/var/run/dbus -v /run/systemd:/run/systemd -v /etc/docker:/etc/docker -it katadocker/kata-deploy kata-deploy-docker install
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could sh ize the block type..

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed - fixed (also yaml blocks).


The path to the runtime provided by the Kata Containers snap image is
`/snap/kata-containers/current/usr/bin/kata-runtime`. You should use it to
run Kata Containers with [docker][9] and [kubernetes][10].
run Kata Containers with [docker][9] and [Kubernetes][10].

## Remove snap
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You capitalised the toc, do you need to match the section header (and maybe any of the body) here?
Whilst here, afaict Ubuntu never capitalise 'snap' ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't follow? This section heading does match the toc (which I actually lower-cased)...?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ay, yep, I read the patch backwards ;-) np

@GabyCT
Copy link
Contributor

GabyCT commented May 27, 2019

/test

Correct typos and resolve formatting issues including incorrect heading
levels and missing TOC entries.

Fixes: kata-containers#541.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
@jodh-intel
Copy link
Contributor Author

Gah - this gets me every time! 😄

Kernel directory has changes check kernel/kata_config_version changed
ERROR: Please bump version in kernel/kata_config_version

/retest

@jodh-intel jodh-intel merged commit 4a97337 into kata-containers:master May 28, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix doc spelling and formatting
4 participants