Skip to content

feat: Add minimal Vale configuration, existing package files #220

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

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
StylesPath = styles
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want it clear that this is a PoC for now....

Suggested change
StylesPath = styles
# This is a PoC, until we have a configuration that matches our style guide at
# https://github.com/nginx/documentation/blob/main/templates/style-guide.md
StylesPath = styles

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the PR being in a draft state not create sufficient enough barrier to entry?

Someone would have to check out the branch to attempt to use it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess I don't understand your approach to this PR / change. Once it's taken out of draft, reviewed, and merged, I'm thinking this will be a PoC for a while -- until we're able to test this on a number of NGINX docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't intend to swap this to a review state until it's been tested across multiple documentation sets, and even then, it's an optional artifact for people to interact with until it's enforced as a requirement by both consensus and CI tooling.

MinAlertLevel = suggestion

Vocab = NGINX, Kubernetes

Packages = Microsoft, Hugo

[*.{md}]

BasedOnStyles = NGINX, Microsoft
13 changes: 13 additions & 0 deletions documentation/README.md
Original file line number Diff line number Diff line change
@@ -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)
1 change: 1 addition & 0 deletions documentation/vale.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Updating Vale rules
6 changes: 6 additions & 0 deletions styles/NGINX/Terms.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
extends: substitution
message: Consider using '%s' instead of '%s'
level: warning
ignorecase: false
swap:
hostname: host name
7 changes: 7 additions & 0 deletions styles/config/vocabularies/Kubernetes/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
(?i)containerPort
Gateway API
Helm
HTTPRoute
kubectl
namespace
(?i)nodePort
3 changes: 3 additions & 0 deletions styles/config/vocabularies/NGINX/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
API
(?i)NGINX
ghcode