iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
opensearch-docs-cn/.vale.ini

71 lines
2.0 KiB
INI
Raw Normal View History

Add style workflow (#3909) * Tweak rules Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rule changes Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove the following and simple Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Revised rules and added tests Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Soft rollout with only spelling and terms Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add Vale to readme Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Only lint modified and added files Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove run on workflow dispatch Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Removed only added and modified files Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added please Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Changed min alert level to warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Don't fail on error and minor changes Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove fail on error Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Attempt to have vale not fail Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fixed links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update README.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update README.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-03 12:34:05 -04:00
StylesPath = ".github/vale/styles"
Vocab = "OpenSearch"
MinAlertLevel = warning
SkippedScopes = code, style
[*.md]
BasedOnStyles = Vale, OpenSearch
BlockIgnores = {%-?\s*comment[.|\s|\S]*?endcomment\s*-?%}, \
{%\s*raw[.|\s|\S]*?endraw\s*%}, \
{:+\s*[\.\w-\s]*\s*}, \
{%\s+[^%]*%}
# ignore variables
TokenIgnores = [a-zA-Z_]+((?:_|\.)[a-zA-Z]+)+
# override Vale spelling
Vale.Spelling = NO
Vale.Repetition = NO
Vale.Terms = YES
Turn on style rules for the style workflow (#4141) * Turn on style rules for the style workflow Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Turn off suggestions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-22 15:41:02 -04:00
OpenSearch.AcronymParentheses = YES
OpenSearch.AdverbsOfTime = YES
OpenSearch.Ampersand = YES
OpenSearch.Cyber = YES
OpenSearch.DashSpacing = YES
OpenSearch.DirectionAboveBelow = YES
OpenSearch.DirectionTopBottom = YES
OpenSearch.Exclamation = YES
OpenSearch.FailoverNoun = YES
OpenSearch.FailoverVerb = YES
Add style workflow (#3909) * Tweak rules Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rule changes Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove the following and simple Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Revised rules and added tests Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Soft rollout with only spelling and terms Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add Vale to readme Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Only lint modified and added files Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove run on workflow dispatch Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Removed only added and modified files Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added please Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Changed min alert level to warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Don't fail on error and minor changes Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove fail on error Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Attempt to have vale not fail Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fixed links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update README.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update README.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-03 12:34:05 -04:00
OpenSearch.FutureTense = NO
Turn on style rules for the style workflow (#4141) * Turn on style rules for the style workflow Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Turn off suggestions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-22 15:41:02 -04:00
OpenSearch.HeadingAcronyms = YES
Add processor to processor names and links to further info (#5786) Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-12-05 14:49:46 -05:00
OpenSearch.HeadingCapitalization = YES
Turn on style rules for the style workflow (#4141) * Turn on style rules for the style workflow Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Turn off suggestions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-22 15:41:02 -04:00
OpenSearch.HeadingColon = YES
OpenSearch.HeadingPunctuation = YES
OpenSearch.Inclusive = YES
OpenSearch.LatinismsElimination = YES
OpenSearch.LatinismsSubstitution = YES
Ignore camel case in heading capitalization, add double slash and double parentheses rules to Vale (#6165) Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2024-01-16 12:55:47 -05:00
OpenSearch.LinksDoubleParentheses = YES
OpenSearch.LinksDoubleSlash = YES
Turn on style rules for the style workflow (#4141) * Turn on style rules for the style workflow Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Turn off suggestions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-22 15:41:02 -04:00
OpenSearch.LinksEndSlash = YES
OpenSearch.LinksMidSlash = YES
OpenSearch.LoginNoun = YES
OpenSearch.LoginVerb = YES
OpenSearch.LogoutNoun = YES
OpenSearch.LogoutVerb = YES
OpenSearch.MergeConflicts = YES
OpenSearch.OxfordComma = YES
Add style workflow (#3909) * Tweak rules Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rule changes Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove the following and simple Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Revised rules and added tests Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Soft rollout with only spelling and terms Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add Vale to readme Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Only lint modified and added files Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove run on workflow dispatch Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Removed only added and modified files Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added please Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Changed min alert level to warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Don't fail on error and minor changes Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove fail on error Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Attempt to have vale not fail Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fixed links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update README.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update README.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-03 12:34:05 -04:00
OpenSearch.PassiveVoice = NO
Turn on style rules for the style workflow (#4141) * Turn on style rules for the style workflow Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Turn off suggestions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-22 15:41:02 -04:00
OpenSearch.Please = YES
OpenSearch.Range = YES
OpenSearch.Repetition = YES
OpenSearch.RolloverNoun = YES
OpenSearch.RolloverVerb = YES
OpenSearch.SetupNoun = YES
OpenSearch.SetupVerb = YES
Update style workflow (#4472) * Update style workflow with sigv4 and sharding Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change heading capitalization to work with colons Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add more words Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Ignore lowercase k in k-NN Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add sharding Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-07-05 10:01:16 -04:00
OpenSearch.SignatureV4 = YES
Turn on style rules for the style workflow (#4141) * Turn on style rules for the style workflow Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Turn off suggestions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-22 15:41:02 -04:00
OpenSearch.Simple = YES
OpenSearch.SpacingPunctuation = YES
OpenSearch.SpacingSlash = YES
OpenSearch.SpacingWords = YES
Add style workflow (#3909) * Tweak rules Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rule changes Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove the following and simple Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Revised rules and added tests Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Soft rollout with only spelling and terms Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add Vale to readme Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Only lint modified and added files Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove run on workflow dispatch Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Removed only added and modified files Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added please Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Changed min alert level to warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Don't fail on error and minor changes Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove fail on error Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Attempt to have vale not fail Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fixed links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update README.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update README.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-03 12:34:05 -04:00
OpenSearch.Spelling = YES
Turn on style rules for the style workflow (#4141) * Turn on style rules for the style workflow Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Turn off suggestions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-22 15:41:02 -04:00
OpenSearch.StackedHeadings = YES
Turn on substitutions and lint only added lines in style workflow (#4025) Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-05 14:44:51 -04:00
OpenSearch.SubstitutionsError = YES
Turn on style rules for the style workflow (#4141) * Turn on style rules for the style workflow Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Turn off suggestions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-22 15:41:02 -04:00
OpenSearch.SubstitutionsSuggestion = YES
OpenSearch.TableHeadings = YES
OpenSearch.TimeoutNoun = YES
OpenSearch.TimeoutVerb = YES
OpenSearch.UnitsNames = YES
OpenSearch.UnitsSpacing = YES
OpenSearch.Version = YES