From d3f126731512387bbca4b1958184f0bc74d8eb24 Mon Sep 17 00:00:00 2001 From: Jerry Aldrich Date: Wed, 10 Oct 2018 13:17:05 -0700 Subject: [PATCH] docs: Add version to multiple descriptions doc (#3477) Signed-off-by: Jerry Aldrich --- docs/dsl_inspec.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dsl_inspec.md b/docs/dsl_inspec.md index 9854c485e..38667c6f8 100644 --- a/docs/dsl_inspec.md +++ b/docs/dsl_inspec.md @@ -27,7 +27,7 @@ control 'sshd-8' do impact 0.6 title 'Server: Configure the service port' desc 'Always specify which port the SSH server should listen.' - desc 'rationale', 'This ensures that there are no unexpected settings' + desc 'rationale', 'This ensures that there are no unexpected settings' # Requires InSpec >=2.3.4 tag 'ssh','sshd','openssh-server' tag cce: 'CCE-27072-8' ref 'NSA-RH6-STIG - Section 3.5.2.1', url: 'https://www.nsa.gov/ia/_files/os/redhat/rhel5-guide-i731.pdf' @@ -42,7 +42,7 @@ where * `'sshd-8'` is the name of the control * `impact`, `title`, and `desc` define metadata that fully describes the importance of the control, its purpose, with a succinct and complete description -* `desc` when given only one argument it sets the default description. When given 2 arguments (see: `'rationale'`) it will use the first argument as a header when rendering in Automate +* `desc` when given only one argument it sets the default description. As of InSpec 2.3.4, when given 2 arguments (see: `'rationale'`) it will use the first argument as a header when rendering in Automate * `impact` is an float that measures the importance of the compliance results and must be a value between `0.0` and `1.0`. The value ranges are: * `0.0 to <0.4` these are controls with minor criticality * `0.4 to <0.7` these are controls with major criticality