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

docs: add new numbers rule DOC-1107 #25

Merged
merged 4 commits into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Copyright (c) Spectro Cloud
# SPDX-License-Identifier: Apache-2.0

extends: existence
message: "Spell out numbers zero through nine. You mentioned '%s'."
link: "https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Numbers"
ignorecase: true
level: error
nonword: false
scope: text
tokens:
- '\b([0-9]/[0-9])\b'
- '(?<!\b(?:January|February|March|April|May|June|July|August|September|October|November|December)\s)\b\[0-9]\b'
- '\b(1st)\b'
- '\b(2nd)\b'
- '\b(3rd)\b'
- '\b([0-9]th)\b'
4 changes: 4 additions & 0 deletions packages/spectrocloud-docs-internal/tests/numbers/.vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
StylesPath = ../../styles/
MinAlertLevel = suggestion
[*.md]
spectrocloud-docs-internal.numbers = YES
13 changes: 13 additions & 0 deletions packages/spectrocloud-docs-internal/tests/numbers/fail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Backup Scheduling Options

Both the cluster and workspace backup support the following scheduling options:

- Customize your backup for the exact month, day, hour, and minute of the user's choice.
- Every week on Sunday at midnight.
- Every 2 weeks at midnight.
- Every month on the 1st at midnight.
- Every two months on the 2nd at midnight.
- Every two months on the 3rd at midnight.
- Every two months on the 4th at midnight.
- On the 0 minute of the hour.
- Every 1/2 hour.
22 changes: 22 additions & 0 deletions packages/spectrocloud-docs-internal/tests/numbers/pass.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Create Infrastructure Profile

1. Log in to [Palette](https://console.spectrocloud.com/).

2. From the left **Main Menu** click **Profiles**.

3. Click on the **Add Cluster Profile** button.

4. Fill out the following input values and ensure you select **Infrastructure** for the type. Click on **Next** to
continue.

| **Field** | **Description** |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name** | A custom name for the profile. |
| **Version** | You only need to specify a version if you create multiple versions of a profile using the same profile name. Default: `1.0.0`. |
| **Description** | Use the description to provide context about the profile. |
| **Type** | **Infrastructure** |
| **Tags** | Assign any desired profile tags. Tags propagate to the Virtual Machines (VMs) deployed in the cloud or data center environment when clusters are created from this cluster profile. Example: `owner` or `region`. |

5. You should have 10 layers in your profile.

6. It is currently November 3, 2024.
17 changes: 17 additions & 0 deletions packages/spectrocloud/styles/spectrocloud/numbers.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Copyright (c) Spectro Cloud
# SPDX-License-Identifier: Apache-2.0

extends: existence
message: "Spell out numbers zero through nine. You mentioned '%s'."
link: "https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Numbers"
ignorecase: true
level: error
nonword: false
scope: text
tokens:
- '\b([0-9]/[0-9])\b'
- '(?<!\b(?:January|February|March|April|May|June|July|August|September|October|November|December)\s)\b\[0-9]\b'
- '\b(1st)\b'
- '\b(2nd)\b'
- '\b(3rd)\b'
- '\b([0-9]th)\b'
4 changes: 4 additions & 0 deletions packages/spectrocloud/tests/numbers/.vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
StylesPath = ../../styles/
MinAlertLevel = suggestion
[*.md]
spectrocloud.numbers = YES
13 changes: 13 additions & 0 deletions packages/spectrocloud/tests/numbers/fail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Backup Scheduling Options

Both the cluster and workspace backup support the following scheduling options:

- Customize your backup for the exact month, day, hour, and minute of the user's choice.
- Every week on Sunday at midnight.
- Every 2 weeks at midnight.
- Every month on the 1st at midnight.
- Every two months on the 2nd at midnight.
- Every two months on the 3rd at midnight.
- Every two months on the 4th at midnight.
- On the 0 minute of the hour.
- Every 1/2 hour.
22 changes: 22 additions & 0 deletions packages/spectrocloud/tests/numbers/pass.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Create Infrastructure Profile

1. Log in to [Palette](https://console.spectrocloud.com/).

2. From the left **Main Menu** click **Profiles**.

3. Click on the **Add Cluster Profile** button.

4. Fill out the following input values and ensure you select **Infrastructure** for the type. Click on **Next** to
continue.

| **Field** | **Description** |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name** | A custom name for the profile. |
| **Version** | You only need to specify a version if you create multiple versions of a profile using the same profile name. Default: `1.0.0`. |
| **Description** | Use the description to provide context about the profile. |
| **Type** | **Infrastructure** |
| **Tags** | Assign any desired profile tags. Tags propagate to the Virtual Machines (VMs) deployed in the cloud or data center environment when clusters are created from this cluster profile. Example: `owner` or `region`. |

5. You should have 10 layers in your profile.

6. It is currently November 3, 2024.