-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add a GitHub workflow to check syntax with Vale
Also corrected some typos.
- Loading branch information
Showing
10 changed files
with
329 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| name: Check spelling & grammar | ||
| on: [push, workflow_dispatch] | ||
|
|
||
| jobs: | ||
| check-syntax: | ||
| name: vale | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
|
|
||
| - name: Checkout this repository | ||
| uses: actions/[email protected] | ||
|
|
||
| - name: Install Vale | ||
| run: | | ||
| wget https://github.com/errata-ai/vale/releases/download/v3.7.0/vale_3.7.0_Linux_64-bit.tar.gz -O vale.tar.gz | ||
| tar -xvzf vale.tar.gz vale | ||
| rm vale.tar.gz | ||
| # Cannot run the action as reviewdog as an issue & don't fail on errors. See https://github.com/reviewdog/reviewdog/issues/1408 | ||
| - name: Validate the syntax | ||
| run: ./vale --config=.vale.ini . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| StylesPath = .vale | ||
| Vocab = base | ||
|
|
||
| [formats] | ||
| mdx = md | ||
|
|
||
| [*.md] | ||
| BasedOnStyles = Custom | ||
| Packages = alex | ||
| BlockIgnores = (?s) *(import.*?\n), \ | ||
| (?s) *(### gitops\n), \ | ||
| (?s) *(### Can I give the gitops repository another name\?\n) | ||
| TokenIgnores = (?s) *(export.*?\n) |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| # A | ||
| argo | ||
| argocd | ||
| atlantis | ||
| aws | ||
|
|
||
| # B | ||
|
|
||
| # C | ||
| chartmuseum | ||
| civo | ||
| cli | ||
| Clusterception | ||
| composable | ||
| config | ||
| cronjob | ||
|
|
||
| # D | ||
|
|
||
| # E | ||
| ecr | ||
| eks | ||
| Entra | ||
|
|
||
| # F | ||
|
|
||
| # G | ||
| gcp | ||
| github | ||
| gitlab | ||
| gitops | ||
|
|
||
| # H | ||
| Hashicorp | ||
| https | ||
|
|
||
| # I | ||
| iam | ||
|
|
||
| # J | ||
|
|
||
| # K | ||
| kubeconfig | ||
| Kubefirst | ||
| kubernetes | ||
|
|
||
| # L | ||
|
|
||
| # M | ||
|
|
||
| # N | ||
|
|
||
| # O | ||
| oidc | ||
|
|
||
| # P | ||
|
|
||
| # Q | ||
|
|
||
| # R | ||
| repo | ||
|
|
||
| # S | ||
|
|
||
| # T | ||
| terraform | ||
|
|
||
| # U | ||
| ui | ||
| url | ||
|
|
||
| # V | ||
| vpc | ||
|
|
||
| # W | ||
|
|
||
| # X | ||
|
|
||
| # Y | ||
|
|
||
| # Z |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| extends: spelling | ||
| message: "Did you really mean '%s'?" | ||
| level: error | ||
| ignore: | ||
| - .vale/Custom/ignore.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| extends: substitution | ||
| message: Consider using '%s' instead of '%s' | ||
| ignorecase: false | ||
| level: error | ||
| swap: | ||
| # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX) | ||
| '(?<=^| )argo [C|c][D|d](?=$| |\.)': Argo CD | ||
| # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX) | ||
| '(?<=^| )Argo [C|c][D|d](?=$| |\.)': Argo CD | ||
| # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX) | ||
| '(?<=^| )[A|a]rgo[C|c][D|d](?=$| |\.)': Argo CD | ||
| 'argo [W|w]orkflows?': Argo Workflows | ||
| 'Argo [W|w]orkflows?': Argo Workflows | ||
| atlantis: Atlantis | ||
| chartmuseum: ChartMuseum | ||
| cli: CLI | ||
| # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX) | ||
| '(?<=^| )civo(?=$| |\.)': Civo | ||
| # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX) | ||
| '(?<=^| )CIVO(?=$| |\.)': Civo | ||
| # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX) | ||
| '(?<=^| )configs?(?=$| |\.)': configurations | ||
| cronjob: CronJob | ||
| ecr: ECR | ||
| eks: EKS | ||
| 'digital[o|O]cean': DigitalOcean | ||
| '[d|D]igitalocean': DigitalOcean | ||
| docker: Docker | ||
| gcp: Google Cloud | ||
| gcp cloud: Google Cloud | ||
| '[G|g]ithub': GitHub | ||
| 'git[H|h]ub': GitHub | ||
| '[G|g]itlab': GitLab | ||
| 'git[L|l]ab': GitLab | ||
| '(?<=^| )gitops(?=$| |\.)': GitOps for the term or put gitops as inline code for the repository | ||
| google: Google | ||
| Hashicorp: HashiCorp | ||
| helm: Helm | ||
| https: HTTPS | ||
| iam: IAM | ||
| konstruct: Konstruct | ||
| # kubefirst: Kubefirst | ||
| kubernetes: Kubernetes | ||
| mongo: MongoDB | ||
| oidc: OIDC | ||
| repo: repository | ||
| SSH: SSH | ||
| # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX) | ||
| '(?<=^| )terraform(?=$| |\.)': Terraform | ||
| ui: UI | ||
| url: URL | ||
| vault: Vault | ||
| vpc: VPC | ||
| vultr: Vultr |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| # A | ||
| Adedeji | ||
| admunition | ||
| Akamai | ||
| Allin | ||
| anonymize | ||
| Appsmith | ||
| Apress | ||
| auditable | ||
| authentification | ||
| authtoken | ||
| automation | ||
|
|
||
| # B | ||
| Bangser | ||
| Blanco | ||
| Botkube | ||
|
|
||
| # C | ||
| CLI' | ||
| CLIs | ||
| ClusterIssuer | ||
| Codezero | ||
| cofounder | ||
| containerd | ||
| CPU | ||
| Crossplane | ||
| CWFT | ||
|
|
||
| # D | ||
| Datadog | ||
| deprovision | ||
| Devrel | ||
| devrelshow | ||
| Dietz | ||
| Dockerfile | ||
| Docusaurus | ||
|
|
||
| # E | ||
| Emms | ||
|
|
||
| # F | ||
| Fitbit | ||
|
|
||
| # G | ||
| Gamov | ||
| Gitpod | ||
| Gottfried | ||
| Gradle | ||
|
|
||
| # H | ||
| Haimantika | ||
| hardcoded | ||
| Hashnode | ||
| Heilmann | ||
| hotfix | ||
|
|
||
| # I | ||
| IDPs | ||
| Ikechukwu | ||
| interoperate | ||
| Iyengar | ||
|
|
||
| # J | ||
|
|
||
| # K | ||
| kbot | ||
| KMS | ||
| Konstruct | ||
| Kratix | ||
| kubectl | ||
| Kubefirst | ||
| Kubeshop | ||
| Kyverno | ||
|
|
||
| # L | ||
| liblab | ||
| Linode | ||
| livestream | ||
| Livestreams | ||
|
|
||
| # M | ||
| markdownlint | ||
| Mikail | ||
| mkcert | ||
| multinode | ||
|
|
||
| # N | ||
| namespace | ||
| nerdctl | ||
| npm | ||
| ngrok | ||
| Nginx | ||
|
|
||
| # O | ||
| onboarding | ||
| Otterize | ||
|
|
||
| # P | ||
| preconfigure | ||
| preloaded | ||
|
|
||
| # Q | ||
|
|
||
| # R | ||
| Rejekts | ||
| Reloader | ||
| Rizel | ||
| routable | ||
|
|
||
| # S | ||
| Sadogursky | ||
| Scarlett | ||
| Seqera | ||
| Sillars | ||
| Smallstep | ||
| Specsavers | ||
| statestore | ||
| subnet | ||
|
|
||
| # T | ||
| teardown | ||
| Testkube | ||
| Tobiloba | ||
| todo | ||
| toolset | ||
| Tracetest | ||
| Traefik | ||
| truststore | ||
| Typesense | ||
|
|
||
| # U | ||
| uncomment | ||
|
|
||
| # V | ||
| vale | ||
| vcluster | ||
| Viktor | ||
| Vonage | ||
| Vultr | ||
|
|
||
| # W | ||
| walkthrough | ||
|
|
||
| # X | ||
|
|
||
| # Y | ||
|
|
||
| # Z |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters