Merged
Conversation
059e7e6 to
0d32f6c
Compare
Collaborator
|
This is excellent, thank you! I think the As for the next actions, I'm adding the recommendation about editing the Vocabulares in the PR I'm preparing for the public docs. For docs-builder integration, you might want to have a look at this one: elastic/docs-builder#1988 |
theletterf
approved these changes
Dec 5, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #61
Adds two Vale Vocabularies containing Elastic product/feature names and third-party product names. This will likely be easier to manage exact product/feature names without having to add them as exceptions in individual styles.
Process
styles/Elastic/Capitalization.ymland sorted them intoElasticTerms(Elastic-specific products and features) vs.ThirdPartyProducts(non-Elastic products). I created two separate vocabulary files in case we ever want to sync this list of Elastic product names with others (like in docs-builder and the VS Code extension).ElasticTermsand deduplicated as needed.ElasticTerms, for product and feature names that could also be used as a regular word (for example,Agent,Analytics,Machine Learning), I prefixed the strings with(?i)to mark the entire pattern as case-insensitive. This will allow us to use either the title case version when referring to the specific product/feature and the lower case version when using it as a regular word.ThirdPartyProductsand deduplicated as needed.ThirdPartyProducts, there are a several official product names that start with a lower case character. To account for when those product names are used at the beginning of the sentence, I prefixed the strings with(?i)to mark the entire pattern as case-insensitive. (This decision is definitely up for debate.)Potential follow up tasks
IndustryTermslist for additional items likeGeoJSONandQoS.