generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 55
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
ADubhlaoich
wants to merge
9
commits into
main
Choose a base branch
from
docs/add-vale-rules
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
0f9cf55
feat: Add minimal Vale configuration, existing package files
ADubhlaoich e6b61b6
Merge branch 'main' into docs/add-vale-rules
ADubhlaoich 3a27ece
feat: Fix .vale.ini error, update .gitignore file
ADubhlaoich a77b722
Merge branch 'main' into docs/add-vale-rules
ADubhlaoich 650f231
Merge branch 'main' into docs/add-vale-rules
ADubhlaoich c78869f
Merge branch 'main' into docs/add-vale-rules
ADubhlaoich 66d2885
feat: Additional testing work
ADubhlaoich 776e602
Merge branch 'main' into docs/add-vale-rules
ADubhlaoich 6571e0e
Merge branch 'main' into docs/add-vale-rules
ADubhlaoich File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,10 @@ | ||
StylesPath = styles | ||
MinAlertLevel = suggestion | ||
|
||
Vocab = NGINX, Kubernetes | ||
|
||
Packages = Microsoft, Hugo | ||
|
||
[*.{md}] | ||
|
||
BasedOnStyles = NGINX, Microsoft |
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 @@ | ||
# 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) |
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 @@ | ||
# Updating Vale rules |
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: substitution | ||
message: Consider using '%s' instead of '%s' | ||
level: warning | ||
ignorecase: false | ||
swap: | ||
hostname: host name |
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,7 @@ | ||
(?i)containerPort | ||
Gateway API | ||
Helm | ||
HTTPRoute | ||
kubectl | ||
namespace | ||
(?i)nodePort |
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,3 @@ | ||
API | ||
(?i)NGINX | ||
ghcode |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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....
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.