Update inspec check docs for --format option #5617
Conversation
|
✔️ Deploy Preview for chef-inspec ready! 🔨 Explore the source changes: e02972a 🔍 Inspect the deploy log: https://app.netlify.com/sites/chef-inspec/deploys/61386090f4d16b0008a4f8dd 😎 Browse the preview: https://deploy-preview-5617--chef-inspec.netlify.app/inspec/cli |
Signed-off-by: Vasu1105 <vasundhara.jagdale@chef.io>
Vasu1105
force-pushed
the
vasundhara/inspec_check_docs_update
branch
from
fc96c6a
to
2f44f7b
Compare
docs-chef-io/content/inspec/cli.md
Outdated
| @@ -64,7 +64,7 @@ inspec check PATH | |||
| This subcommand has additional options: | |||
|
|
|||
| * ``--format=FORMAT`` | |||
|
|
|||
| The output format to use doc (default), json. If valid format is not provided then it will use the default. | |||
There was a problem hiding this comment.
Is this just checking that the inspec.yml is in a particular format? Wouldn't it just be yaml since it's a yaml file? Or is there JSON data embedded in the yaml file?
There was a problem hiding this comment.
inspec check is a linting utility which checks several aspects of a profile, including the inspec.yml file. The --format flag controls the output format of inspec check. It provides a human-readable ("doc") format, and a machine-readable (json) format.
clintoncwolfe
added
Aspect: Docs
Signed-off-by: Deepa Kumaraswamy <dkumaras@progress.com>
|
Not sure the edits - esp the formats are fine - pls chk n let us know. |
docs-chef-io/content/inspec/cli.md
Outdated
| @@ -64,15 +63,15 @@ inspec check PATH | |||
| This subcommand has additional options: | |||
|
|
|||
| * ``--format=FORMAT`` | |||
|
|
|||
| The output format to use doc (default), json. If valid format is not provided, then it will use the default. | |||
There was a problem hiding this comment.
| The output format to use doc (default), json. If valid format is not provided, then it will use the default. | |
| The output format to use. Valid values: `json` and `doc`. Default value: `doc`. |
Signed-off-by: Vasu1105 <vasundhara.jagdale@chef.io>
Signed-off-by: Vasu1105 <vasundhara.jagdale@chef.io>
|
Kudos, SonarCloud Quality Gate passed!
|
Signed-off-by: Vasu1105 vasundhara.jagdale@chef.io
Description
Updated docs for --format option to add a description and more details.
Related Issue
Fix #2971
Types of changes
Checklist: