Skip to content

Commit

Permalink
Add compliance frameworks to spellcheck
Browse files Browse the repository at this point in the history
We get both of these wrong a lot

Signed-off-by: Tim Smith <[email protected]>
  • Loading branch information
tas50 committed Mar 6, 2024
1 parent 07d7e6b commit 80f1ba4
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 12 deletions.
16 changes: 14 additions & 2 deletions .github/actions/spelling/line_forbidden.patterns
Original file line number Diff line number Diff line change
@@ -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*
Expand Down Expand Up @@ -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
#
Expand Down Expand Up @@ -336,6 +345,9 @@
# s.b. CodeStar
\bCodestar\b

# s.b. AWS Config
\bAWS config\b

# s.b. Copilot
\bCoPilot\b

Expand Down
13 changes: 7 additions & 6 deletions docs/mql/resources/aws-pack/aws.config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 | &#91;&#93;[aws.config.recorder](aws.config.recorder.md) | List of configuration recorders for each region in the account |
| rules | &#91;&#93;[aws.config.rule](aws.config.rule.md) | List of AWS Config rules |
| ID | TYPE | DESCRIPTION |
| ---------------- | --------------------------------------------------------------------- | -------------------------------------------------------------- |
| recorders | &#91;&#93;[aws.config.recorder](aws.config.recorder.md) | List of configuration recorders for each region in the account |
| rules | &#91;&#93;[aws.config.rule](aws.config.rule.md) | List of AWS Config rules |
| deliveryChannels | &#91;&#93;[aws.config.deliverychannel](aws.config.deliverychannel.md) | List of delivery channels for each region in the account |

Check failure on line 27 in docs/mql/resources/aws-pack/aws.config.md

View workflow job for this annotation

GitHub Actions / Run spell check

`deliverychannel` is not a recognized word. (unrecognized-spelling)

**Examples**

Expand Down
4 changes: 2 additions & 2 deletions docs/mql/resources/aws-pack/aws.config.recorder.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/mql/resources/aws-pack/aws.config.rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down

0 comments on commit 80f1ba4

Please sign in to comment.