docs: Fix spelling and formatting

Correct spelling mistakes and resolve formatting issues.

Fixes: #298.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2019-05-24 09:05:44 +01:00
parent 67b66c4d95
commit 14534717c7
3 changed files with 6 additions and 5 deletions

View File

@ -1,3 +1,3 @@
## Kata Containers OSBuiler Code of Conduct ## Kata Containers osbuilder Code of Conduct
Kata Containers follows the [OpenStack Foundation Code of Conduct](https://www.openstack.org/legal/community-code-of-conduct/). Kata Containers follows the [OpenStack Foundation Code of Conduct](https://www.openstack.org/legal/community-code-of-conduct/).

View File

@ -120,7 +120,7 @@ For further details, see [the tests documentation](tests/README.md).
## Platform-Distro Compatibility Matrix ## Platform-Distro Compatibility Matrix
| |Alpine |CentOS |ClearLinux |Debian/Ubuntu |EulerOS |Fedora |openSUSE | | |Alpine |CentOS |Clear Linux |Debian/Ubuntu |EulerOS |Fedora |openSUSE |
|-- |-- |-- |-- |-- |-- |-- |-- | |-- |-- |-- |-- |-- |-- |-- |-- |
|**ARM64** |:heavy_check_mark:|:heavy_check_mark:| | |:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| |**ARM64** |:heavy_check_mark:|:heavy_check_mark:| | |:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:|
|**PPC64le**|:heavy_check_mark:|:heavy_check_mark:| |:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| |**PPC64le**|:heavy_check_mark:|:heavy_check_mark:| |:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:|

View File

@ -1,14 +1,15 @@
* [Supported base OSs](#supported-base-oss) * [Supported base OSs](#supported-base-oss)
* [Rootfs requirements](#rootfs-requirements)
* [Creating a rootfs](#creating-a-rootfs) * [Creating a rootfs](#creating-a-rootfs)
* [Creating a rootfs with kernel modules](#creating-a-rootfs-with-kernel-modules) * [Creating a rootfs with kernel modules](#creating-a-rootfs-with-kernel-modules)
* [Build a rootfs using Docker*](#build-a-rootfs-using-docker) * [Build a rootfs using Docker](#build-a-rootfs-using-docker)
* [Adding support for a new guest OS](#adding-support-for-a-new-guest-os) * [Adding support for a new guest OS](#adding-support-for-a-new-guest-os)
* [Create template files](#create-template-files) * [Create template files](#create-template-files)
* [Modify template files](#modify-template-files) * [Modify template files](#modify-template-files)
* [Expected rootfs directory content](#expected-rootfs-directory-content) * [Expected rootfs directory content](#expected-rootfs-directory-content)
* [Optional - Customise the rootfs](#optional---customise-the-rootfs) * [Optional - Customise the rootfs](#optional---customise-the-rootfs)
* [Adding extra packages](#adding-extra-packages) * [Adding extra packages](#adding-extra-packages)
* [Arbitary rootfs changes](#arbitary-rootfs-changes) * [Arbitrary rootfs changes](#arbitrary-rootfs-changes)
# Building a Guest OS rootfs for Kata Containers # Building a Guest OS rootfs for Kata Containers
@ -186,7 +187,7 @@ To add additional packages, use one of the following methods:
configuration file must use the package names from the distro for which they configuration file must use the package names from the distro for which they
were created. were created.
#### Arbitary rootfs changes #### Arbitrary rootfs changes
Once the rootfs directory is created, you can add and remove files as Once the rootfs directory is created, you can add and remove files as
needed. Changes affect the files included in the final guest image. needed. Changes affect the files included in the final guest image.