If a doc contains commands, they should be non-interactive where
possible to allow for the possibility of automating the testing of the
document in the CI.
Fixes#477.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
New documentation is great, but finding it should be easy. Require that
all new docs are referenced by an existing document in the repo.
Fixes#475.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
- Created a how-to README.
- Moved howto links in top-level README to the how-to README.
- Moved svc-mesh how to into the how-to directory.
Fixes#473.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Removed two list entries in the design README that don't have a
corresponding document to link to.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Fixed the Debian install guide which was pointing to the Ubuntu Docker
install guide by mistake.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
- Add more motivation, background on filesystem sharing
- simplify configuration, installation by utilizing kata deploy
Signed-off-by: Eric Ernst <eric.ernst@intel.com>
virtio-fs has landed as an experimental feature in kata. This patch
enable the basic how-to for this feature.
Fixes: #468
Signed-off-by: Ganesh Maharaj Mahalingam <ganesh.mahalingam@intel.com>
It's a little complicated to understand the note of the section
Install containerd with cri plugin, that says Just check if the cri plugin has
been disabled in the containerd configuration file but if it's disabled
containerd + the runtime class won't work.
fixes#462
Signed-off-by: Julio Montes <julio.montes@intel.com>
Simplify the bullet list of general requirements in the documentation
requirements document at the same time as making the wording
unambiguous.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
The conduit project seems to have renamed itself to linkerd so update
the service mesh document to reflect that.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Fix installing docker on Debian by changing the docker install guide to
ensure that only the `kata-containers.conf` systemd service snippet is
created. Previously, both the snippet and the `daemon.json` Docker
config files were being updated because the latter also specified a bash
code block.
Note that the `daemon.json` section is now consistent with the other
install guides - it just displays the JSON code to add rather than
trying to set it.
Also, added missing shell prompts, changed code blocks into shell (but
not bash) code blocks and fixed a few minor grammar and whitespace
issues.
For further details, see:
- https://github.com/kata-containers/documentation/blob/master/Documentation-Requirements.md
- https://github.com/kata-containers/tests/tree/master/cmd/kata-managerFixes#442.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
