diff --git a/.gitignore b/.gitignore index e0070f1b2..4ee3ece68 100644 --- a/.gitignore +++ b/.gitignore @@ -30,10 +30,10 @@ resources/ .markdownlint.json **/.vscode/ **/.idea/ - -# Local Netlify artifacts -.netlify/plugins/* -.netlify/ + +# Vale files +/styles/Microsoft +/styles/.vale-config/1-Hugo.ini # Local Lighthouse artifacts lighthouse-reports diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 000000000..786c931c1 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,10 @@ +StylesPath = styles +MinAlertLevel = suggestion + +Vocab = NGINX, Kubernetes + +Packages = Microsoft, Hugo + +[*.{md}] + +BasedOnStyles = NGINX, Microsoft \ No newline at end of file diff --git a/documentation/README.md b/documentation/README.md new file mode 100644 index 000000000..b329c627e --- /dev/null +++ b/documentation/README.md @@ -0,0 +1,13 @@ +# NGINX Documentation repository + +This directory contains the maintenance documentation for the NGINX Documentation repository. + +It explains how to configure tooling for the repository, and instructions for some precise tasks. + +If you're interested in contributing to the [NGINX documentation website](https://docs.nginx.com/), check out [CONTRIBUTING.md](https://github.com/nginx/documentation/blob/main/CONTRIBUTING.md). + +Most of the documentation you'll see here is for the DocOps team, maintained publicly as part of NGINX's commitment to transparency and open source. + +## Topics + +- [Updating Vale rules](vale.md) \ No newline at end of file diff --git a/documentation/vale.md b/documentation/vale.md new file mode 100644 index 000000000..f98fffbb0 --- /dev/null +++ b/documentation/vale.md @@ -0,0 +1 @@ +# Updating Vale rules diff --git a/styles/NGINX/Terms.yaml b/styles/NGINX/Terms.yaml new file mode 100644 index 000000000..f381afbd9 --- /dev/null +++ b/styles/NGINX/Terms.yaml @@ -0,0 +1,6 @@ +extends: substitution +message: Consider using '%s' instead of '%s' +level: warning +ignorecase: false +swap: + hostname: host name \ No newline at end of file diff --git a/styles/config/vocabularies/Kubernetes/accept.txt b/styles/config/vocabularies/Kubernetes/accept.txt new file mode 100644 index 000000000..d48a99d30 --- /dev/null +++ b/styles/config/vocabularies/Kubernetes/accept.txt @@ -0,0 +1,7 @@ +(?i)containerPort +Gateway API +Helm +HTTPRoute +kubectl +namespace +(?i)nodePort \ No newline at end of file diff --git a/styles/config/vocabularies/NGINX/accept.txt b/styles/config/vocabularies/NGINX/accept.txt new file mode 100644 index 000000000..99a4c11e1 --- /dev/null +++ b/styles/config/vocabularies/NGINX/accept.txt @@ -0,0 +1,3 @@ +API +(?i)NGINX +ghcode \ No newline at end of file