Minor documentation tweaks to align with our documentation requirements
and thus keep the spell checker happy.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
The link specified in the rota process to search for issues only works
if the user running the query is logged into GitHub. Change the wording
to avoid the need for the user to be logged into GitHub since that
allows the CI to validate the link.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Add more detail to the backport guide including some ASCII graphics
to demonstrate backporting and formatting improvements.
Fixes: #110.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Now we have the table of Kata resources and owners on a wiki page,
let's link it from the main community README to make it easier
to find.
Fixes: #71
Signed-off-by: Graham Whaley <graham.whaley@intel.com>
Add a new document explaining what the Kata Rota Team is and what they
should do.
Fixes: #104.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Update the contributing guide to refer to `golangci-lint` rather than
the old `gometalinter` we used to use.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Add missing links to documents to ensure all docs in this repo can be
discovered easily.
Fixes#99.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
If working on the runtime, it is necessary to return to the top-level
directory after having built `virtcontainers`.
Make this clearer by using a `pushd` and `popd` pair rather than a
single `cd`.
Fixes#93.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Make examples headings unique so that both sets of examples can be
accessed from the TOC.
Partially fixes: #91.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Add the KCSA for CVE-2019-5736.
As this is our first KCSA, also create the KCSA index page and
reference that from the top level README.
Fixes: #85
Signed-off-by: Graham Whaley <graham.whaley@intel.com>
Signed-off-by: Peng Tao <bergwolf@gmail.com>
With the move away from pullapprove and towards github and
Zuul for ack accounting, SoB and WIP checks, we need to update
the documents to reflect this.
Fixes: #76
Signed-off-by: Graham Whaley <graham.whaley@intel.com>
If following the contributing doc and wanting to run make check and
make test in kata-runtime, the virtcontainers/bin/hook executable
is expected to exist. But it only exists if it is compiled and
installed. So a note has been added that if make test|check for
runtime, to ensure that virtcontainers has been compiled and
installed.
Signed-off-by: ccollicutt <curtis@serverascode.com>
Add a full example of creating a PR including explaining how to rebase,
squash commits and force push to include review changes.
Fixes#66.
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
