Skip to content

Commit

Permalink
add vale, including URL checks
Browse files Browse the repository at this point in the history
  • Loading branch information
geoffcline committed Oct 2, 2024
1 parent 111585b commit 4eddf08
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ target/
# virtualenv
venv/
ENV/
vale/styles/AsciiDoc/
vale/styles/RedHat/

# MkDocs documentation
site/
Expand Down
12 changes: 12 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
StylesPath = vale/styles

Packages = RedHat, AsciiDoc, BpgDocs

# Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
[[!.]*.adoc]
BasedOnStyles = RedHat, AsciiDoc, BpgDocs
RedHat.GitLinks = OFF
AsciiDoc.UnsetAttributes = OFF
RedHat.CaseSensitiveTerms = suggestion
RedHat.TermsErrors = warning
RedHat.Spacing = warning
2 changes: 1 addition & 1 deletion latest/bpg/autoscaling/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
:info_titleabbrev: Cluster Autoscaling
:imagesdir: images/

This guide provides advice about Cluter Autoscaling, including guidance for Kubernetes Cluster Autoscaler and Karpenter.
This guide provides advice about Cluster Autoscaling, including guidance for Kubernetes Cluster Autoscaler and Karpenter.

[.topiclist]
[[Topic List]]
Expand Down
31 changes: 31 additions & 0 deletions vale/styles/BpgDocs/ApprovedUrls.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
extends: existence
message: "External domain detected: '%s -- Review non-aws domains carefully"
level: error
scope: raw
ignorecase: true
tokens:
- '(?:^|\s)(https://[^\s]+)(?:$|\s)'
exceptions:
- https://aws.github.io/
- https://kubernetes-sigs.github.io/
- https://aws-observability.github.io/
- https://github.com/aws/
- https://docs.aws.amazon.com/
- https://github.com/aws-samples/
- https://github.com/kubernetes/
- https://aws.amazon.com/
- https://repost.aws/
- https://github.com/bottlerocket-os/
- https://kubernetes.io/
- https://karpenter.sh/
- https://karpenter.sh
- https://anywhere.eks.amazonaws.com/
- https://aws-ia.github.io
- https://eksctl.io/
- https://catalog.workshops.aws/
- https://github.com/awslabs/
- https://console.aws.amazon.com/
- https://github.com/aws-controllers-k8s/
- https://raw.githubusercontent.com/aws-observability/
- https://github.com/kubernetes-sigs/
- https://d1.awsstatic.com/

0 comments on commit 4eddf08

Please sign in to comment.