From 80f1ba47f4de3c406e52ca09408f199d432d62d6 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Tue, 5 Mar 2024 18:53:54 -0800 Subject: [PATCH] Add compliance frameworks to spellcheck We get both of these wrong a lot Signed-off-by: Tim Smith --- .github/actions/spelling/line_forbidden.patterns | 16 ++++++++++++++-- docs/mql/resources/aws-pack/aws.config.md | 13 +++++++------ .../resources/aws-pack/aws.config.recorder.md | 4 ++-- docs/mql/resources/aws-pack/aws.config.rule.md | 4 ++-- 4 files changed, 25 insertions(+), 12 deletions(-) diff --git a/.github/actions/spelling/line_forbidden.patterns b/.github/actions/spelling/line_forbidden.patterns index 2ac05140a..450a15eff 100644 --- a/.github/actions/spelling/line_forbidden.patterns +++ b/.github/actions/spelling/line_forbidden.patterns @@ -1,12 +1,11 @@ # Detect common combinations of valid words that are in fact invalid. # Useful for brand capitalizations - # # Catch placeholder text # -\b[Lo]orem [Ii]psum\ +\b[Ll]orem [Ii]psum\b # PR links left in the release notes \bhttps:\/\/github.com\/mondoohq\/.*\/pull\/\d* @@ -41,6 +40,16 @@ # s.b. Compliance Hub \s[Cc]ompliance hub\b +# +# Compliance Terms +# + +# s.b. SOC 2 +\bSOC2\b + +# s.b. ISO 270001 +\bISO270001\b + # # Industry Terms # @@ -336,6 +345,9 @@ # s.b. CodeStar \bCodestar\b +# s.b. AWS Config +\bAWS config\b + # s.b. Copilot \bCoPilot\b diff --git a/docs/mql/resources/aws-pack/aws.config.md b/docs/mql/resources/aws-pack/aws.config.md index 0f87544d6..89a4804c6 100644 --- a/docs/mql/resources/aws-pack/aws.config.md +++ b/docs/mql/resources/aws-pack/aws.config.md @@ -3,7 +3,7 @@ title: aws.config id: aws.config sidebar_label: aws.config displayed_sidebar: MQL -description: AWS config +description: AWS Config --- # aws.config @@ -14,16 +14,17 @@ description: AWS config **Description** -AWS config +AWS Config Use the `aws.config` resource to assess the configuration of the AWS Config service. The resource provides the `.recorders` field, which returns a list of `aws.config.recorder` resources representing all AWS Config recorders configured across all enabled regions, as well as the `.rules` field, which returns a list of `aws.config.rule` resources representing all AWS Config rules configured across all enabled regions in the account. **Fields** -| ID | TYPE | DESCRIPTION | -| --------- | ------------------------------------------------------- | -------------------------------------------------------------- | -| recorders | [][aws.config.recorder](aws.config.recorder.md) | List of configuration recorders for each region in the account | -| rules | [][aws.config.rule](aws.config.rule.md) | List of AWS Config rules | +| ID | TYPE | DESCRIPTION | +| ---------------- | --------------------------------------------------------------------- | -------------------------------------------------------------- | +| recorders | [][aws.config.recorder](aws.config.recorder.md) | List of configuration recorders for each region in the account | +| rules | [][aws.config.rule](aws.config.rule.md) | List of AWS Config rules | +| deliveryChannels | [][aws.config.deliverychannel](aws.config.deliverychannel.md) | List of delivery channels for each region in the account | **Examples** diff --git a/docs/mql/resources/aws-pack/aws.config.recorder.md b/docs/mql/resources/aws-pack/aws.config.recorder.md index 353682c87..c18df3177 100644 --- a/docs/mql/resources/aws-pack/aws.config.recorder.md +++ b/docs/mql/resources/aws-pack/aws.config.recorder.md @@ -3,7 +3,7 @@ title: aws.config.recorder id: aws.config.recorder sidebar_label: aws.config.recorder displayed_sidebar: MQL -description: AWS config recorder +description: AWS Config recorder --- # aws.config.recorder @@ -14,7 +14,7 @@ description: AWS config recorder **Description** -AWS config recorder +AWS Config recorder The `aws.config.recorder` resource provides fields representing an individual AWS Config recorder configured within an account. For usage, read the `aws.config` resource documentation. diff --git a/docs/mql/resources/aws-pack/aws.config.rule.md b/docs/mql/resources/aws-pack/aws.config.rule.md index a6b896286..f76a83853 100644 --- a/docs/mql/resources/aws-pack/aws.config.rule.md +++ b/docs/mql/resources/aws-pack/aws.config.rule.md @@ -3,7 +3,7 @@ title: aws.config.rule id: aws.config.rule sidebar_label: aws.config.rule displayed_sidebar: MQL -description: AWS config rule +description: AWS Config rule --- # aws.config.rule @@ -14,7 +14,7 @@ description: AWS config rule **Description** -AWS config rule +AWS Config rule The `aws.config.rule` resource provides fields representing an individual AWS Config rule configured within an account. For usage, read the `aws.config` resource documentation.