Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc fixes #165

Merged
merged 2 commits into from May 27, 2019
Merged

Doc fixes #165

merged 2 commits into from May 27, 2019

Conversation

jodh-intel
Copy link
Contributor

Quote code blocks and don't use apostrophes to quote words as this defeats spell checkers.

Also added Tables of Contents and missing entries.

Fixes: #164.

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

Quote code blocks and don't use apostrophes to quote words as this
defeats spell checkers.

Fixes: kata-containers#164.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Added Tables of Contents and missing entries.

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

@grahamwhaley grahamwhaley left a comment

Choose a reason for hiding this comment

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

lgtm


A metrics machine must have a valid `checkmetrics` configuration file in `/etc/checkmetrics`
in order to verify the metrics CI results.

To aid setup of this file on the bare metal metrics slaves, the `add_checkmetrics.yaml`
ansible script can be used. A local checkmetrics toml file must be present in the same
Ansible script can be used. A local `checkmetrics` TOML file must be present in the same`
Copy link

Choose a reason for hiding this comment

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

ansible ?

Copy link
Contributor

Choose a reason for hiding this comment

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

yep, as in https://www.ansible.com/ ... not sure what your intention was @devimc - just surprised, or you wanted the capitalisation turned back? :-)

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, I see - you mean code block it - I see....

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 was treating this as the "project name" (Ansible) but should it be treated as a command name then?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think in that context it is the project name.

@GabyCT GabyCT merged commit f8e923c into kata-containers:master May 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Fix formatting
4 participants