remove hyphen from "auto unseal" in OpenBao #182
Closed
Conversation
This file contains hidden or 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
to remove "auto-unseal" error in documentation test
The internet is not entirely certain whether "auto unseal" should have a hyphen. Subjectively, a majority does not use a hyphen, and the vale style guide suggests "auto-" being an antipattern, so let's not use the hyphen.
arska
changed the title
Contributor
|
I had this discussion with @ioboi about this and decided to use the same spelling as the OpenBao docs. This will make searches across both docs easier. I added a "make vale happy" commit into the ADR which will be merged on Thursday: d4caf9a I can cherrypick it onto master before that if you like. EDIT: sorry picked the wrong person for the mention 🙈 |
Member
Author
|
No hard feelings from my side. Closing this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The internet is not entirely certain whether "auto unseal" should have a hyphen. Subjectively, most people do not use hyphens, and the Vale style guide suggests that "auto-" is an antipattern, so let's not use one.
While working to make Vale happy, upgrade the Vale version in the makefile.
Summary
Checklist
change,decision,requirement/quality,requirement/functional,dependencyas they show up in the changelog