-
Notifications
You must be signed in to change notification settings - Fork 179
Remove duplicate subs, subs for generic words, and outdated terms #4042
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
base: main
Are you sure you want to change the base?
Conversation
Vale Linting ResultsSummary: 2 warnings, 104 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/transforms/transform-limitations.md | 82 | Elastic.DontUse | Don't use 'just'. |
| release-notes/elastic-security/known-issues.md | 97 | Elastic.DontUse | Don't use 'just'. |
💡 Suggestions (104)
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/distributed-architecture/clusters-nodes-shards/node-roles.md | 85 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| deploy-manage/distributed-architecture/clusters-nodes-shards/node-roles.md | 304 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| deploy-manage/distributed-architecture/clusters-nodes-shards/node-roles.md | 312 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI. |
| deploy-manage/monitor/stack-monitoring/es-pause-export.md | 17 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| explore-analyze/machine-learning/data-frame-analytics/ml-dfa-finding-outliers.md | 119 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI. |
| explore-analyze/machine-learning/data-frame-analytics/ml-dfa-finding-outliers.md | 119 | Elastic.Wordiness | Consider using 'because' instead of 'Since'. |
| explore-analyze/machine-learning/data-frame-analytics/ml-dfa-finding-outliers.md | 221 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/transforms/ecommerce-transforms.md | 15 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI. |
| explore-analyze/transforms/ecommerce-transforms.md | 22 | Elastic.FutureTense | 'will look' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/transforms/ecommerce-transforms.md | 22 | Elastic.Exclamation | Use exclamation points sparingly. Consider removing the exclamation point. |
| explore-analyze/transforms/ecommerce-transforms.md | 28 | Elastic.WordChoice | Consider using 'efficient' instead of 'simple', unless the term is in the UI. |
| explore-analyze/transforms/ecommerce-transforms.md | 95 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/transforms/ecommerce-transforms.md | 96 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/transforms/ecommerce-transforms.md | 176 | Elastic.FutureTense | 'will use' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/transforms/ecommerce-transforms.md | 252 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/transforms/ecommerce-transforms.md | 362 | Elastic.WordChoice | Consider using 'efficient' instead of 'simple', unless the term is in the UI. |
| explore-analyze/transforms/ecommerce-transforms.md | 362 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/transforms/transform-api-quickref.md | 31 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/transforms/transform-checkpoints.md | 22 | Elastic.WordChoice | Consider using 'efficient' instead of 'simple', unless the term is in the UI. |
| explore-analyze/transforms/transform-checkpoints.md | 32 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/transforms/transform-checkpoints.md | 46 | Elastic.Wordiness | Consider using 'usually' instead of 'In most cases'. |
| explore-analyze/transforms/transform-checkpoints.md | 46 | Elastic.Acronyms | 'ECS' has no definition. |
| explore-analyze/transforms/transform-checkpoints.md | 87 | Elastic.Wordiness | Consider using 'some' instead of 'some of the'. |
| explore-analyze/transforms/transform-examples.md | 14 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/transforms/transform-examples.md | 67 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/transforms/transform-examples.md | 95 | Elastic.Wordiness | Consider using 'sometimes' instead of 'In some cases'. |
| explore-analyze/transforms/transform-examples.md | 307 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/transforms/transform-examples.md | 307 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/transforms/transform-examples.md | 422 | Elastic.Acronyms | 'ISO' has no definition. |
| explore-analyze/transforms/transform-limitations.md | 34 | Elastic.Wordiness | Consider using 'before' instead of 'prior to'. |
| explore-analyze/transforms/transform-limitations.md | 35 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 36 | Elastic.FutureTense | 'will receive' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/transforms/transform-limitations.md | 40 | Elastic.Wordiness | Consider using 'impossible' instead of 'not possible'. |
| explore-analyze/transforms/transform-limitations.md | 54 | Elastic.FutureTense | 'will deduce' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/transforms/transform-limitations.md | 54 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/transforms/transform-limitations.md | 54 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 54 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 58 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 58 | Elastic.Wordiness | Consider using 'before' instead of 'prior to'. |
| explore-analyze/transforms/transform-limitations.md | 60 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 62 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 72 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 72 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 72 | Elastic.FutureTense | 'will allow' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/transforms/transform-limitations.md | 82 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 84 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 86 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/transforms/transform-limitations.md | 90 | Elastic.Wordiness | Consider using 'because' instead of 'since'. |
| explore-analyze/transforms/transform-limitations.md | 94 | Elastic.FutureTense | 'will fail' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/transforms/transform-limitations.md | 96 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 122 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 128 | Elastic.Wordiness | Consider using 'many' instead of 'a large number of'. |
| explore-analyze/transforms/transform-limitations.md | 128 | Elastic.Acronyms | 'SLO' has no definition. |
| explore-analyze/transforms/transform-limitations.md | 130 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 135 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 144 | Elastic.Acronyms | 'SLO' has no definition. |
| explore-analyze/transforms/transform-limitations.md | 154 | Elastic.Acronyms | 'PIT' has no definition. |
| explore-analyze/transforms/transform-limitations.md | 156 | Elastic.Acronyms | 'PIT' has no definition. |
| explore-analyze/transforms/transform-limitations.md | 158 | Elastic.Acronyms | 'PIT' has no definition. |
| explore-analyze/transforms/transform-limitations.md | 162 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| explore-analyze/transforms/transform-limitations.md | 162 | Elastic.Acronyms | 'PIT' has no definition. |
| explore-analyze/transforms/transform-limitations.md | 179 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/transforms/transform-overview.md | 23 | Elastic.Semicolons | Use semicolons judiciously. |
| explore-analyze/transforms/transform-overview.md | 35 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/transforms/transform-painless-examples.md | 30 | Elastic.Wordiness | Consider using 'before' instead of 'prior to'. |
| explore-analyze/transforms/transform-painless-examples.md | 181 | Elastic.Wordiness | Consider using 'remove' instead of 'extract'. |
| explore-analyze/transforms/transform-scale.md | 14 | Elastic.Wordiness | Consider using 'whether' instead of 'whether or not'. |
| explore-analyze/transforms/transform-scale.md | 28 | Elastic.EmDashes | Don't put a space before or after a dash. |
| explore-analyze/transforms/transform-scale.md | 28 | Elastic.Semicolons | Use semicolons judiciously. |
| explore-analyze/transforms/transform-scale.md | 28 | Elastic.Wordiness | Consider using 'act' instead of 'take action'. |
| explore-analyze/transforms/transform-scale.md | 42 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-scale.md | 45 | Elastic.Wordiness | Consider using 'to' instead of 'in order to'. |
| explore-analyze/transforms/transform-scale.md | 45 | Elastic.Wordiness | Consider using 'before' instead of 'prior to'. |
| explore-analyze/transforms/transform-scale.md | 52 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| explore-analyze/transforms/transform-scale.md | 81 | Elastic.EmDashes | Don't put a space before or after a dash. |
| explore-analyze/transforms/transform-scale.md | 81 | Elastic.EmDashes | Don't put a space before or after a dash. |
| explore-analyze/transforms/transform-scale.md | 85 | Elastic.Semicolons | Use semicolons judiciously. |
| explore-analyze/transforms/transform-scale.md | 85 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-setup.md | 33 | Elastic.Wordiness | Consider using 'all' instead of 'all of '. |
| explore-analyze/transforms/transform-setup.md | 47 | Elastic.Wordiness | Consider using 'all' instead of 'all of '. |
| explore-analyze/transforms/transform-setup.md | 58 | Elastic.Wordiness | Consider using 'all' instead of 'all of '. |
| explore-analyze/transforms/transform-setup.md | 71 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/transforms/transform-usage.md | 31 | Elastic.Wordiness | Consider using 'many' instead of 'a large number of'. |
| explore-analyze/transforms/transform-usage.md | 31 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/transforms/transform-usage.md | 35 | Elastic.Wordiness | Consider using 'sometimes' instead of 'In some cases'. |
| explore-analyze/transforms/transform-usage.md | 35 | Elastic.FutureTense | 'will skip' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/transforms/transform-usage.md | 37 | Elastic.FutureTense | 'will instead' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| release-notes/elastic-security/known-issues.md | 64 | Elastic.FutureTense | 'will fail' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| release-notes/elastic-security/known-issues.md | 89 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| release-notes/elastic-security/known-issues.md | 93 | Elastic.FutureTense | 'will impact' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| release-notes/elastic-security/known-issues.md | 100 | Elastic.FutureTense | 'will need' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| release-notes/elastic-security/known-issues.md | 115 | Elastic.Acronyms | 'CNVM' has no definition. |
| solutions/observability/apm/apm-server/use-internal-collection-to-send-monitoring-data.md | 83 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| solutions/security/get-started/spaces-defend-faq.md | 140 | Elastic.FutureTense | 'will automatically' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| solutions/security/get-started/spaces-defend-faq.md | 230 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| solutions/security/get-started/spaces-defend-faq.md | 230 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| solutions/security/get-started/spaces-defend-faq.md | 230 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| solutions/security/get-started/spaces-defend-faq.md | 230 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/elasticsearch/increase-tier-capacity.md | 122 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI. |
| troubleshoot/elasticsearch/increase-tier-capacity.md | 200 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI. |
| troubleshoot/elasticsearch/transform-troubleshooting.md | 29 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| troubleshoot/ingest/fleet/frequently-asked-questions.md | 100 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| troubleshoot/observability/troubleshoot-mapping-issues.md | 23 | Elastic.FutureTense | 'will not' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| troubleshoot/observability/troubleshoot-mapping-issues.md | 32 | Elastic.Wordiness | Consider using 'remove' instead of 'eliminate'. |
bmorelli25
left a comment
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.
Makes sense. I agree there are probably a lot more of these that we can get rid of.
Changes look good. PRs like this make me miss our asciidoc line-by-line HTML diffs. Having that feature would make reviewing this quite easy. But I don't see any bad substitutions or unexpected changes.
solutions/observability/apm/apm-server/use-internal-collection-to-send-monitoring-data.md
Outdated
Show resolved
Hide resolved
deploy-manage/monitor/stack-monitoring/es-monitoring-collectors.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
|
|
||
| 4. [Install {{metricbeat}}](beats://reference/metricbeat/metricbeat-installation-configuration.md) on the same server as {{kib}}. | ||
| 5. Enable the {{kib}} {{xpack}} module in {{metricbeat}}.<br> | ||
| 5. Enable the {{kib}} X-Pack module in {{metricbeat}}.<br> |
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.
- Enable the {{kib}} X-Pack module in {{metricbeat}}.
I thought maybe this was no longer a thing anymore either, but see it's still mentioned in https://www.elastic.co/docs/reference/beats/metricbeat/metricbeat-module-kibana#_usage_for_stack_monitoring_4
Thanks for incorporating my other suggestions, now it LGTM
Related to #3536
Background
In my opinion,
subsaren't as helpful if we don't use them consistently. In elastic/elastic-docs-vscode#2, we added inline warnings when an author hard-codes the value of a sub instead of using the sub key, which provides a light-touch way to encourage consistent use of subs and weed out unnecessary subs without introducing a bunch of errors.Summary
Removes duplicate subs (different keys for the same value), subs for generic words/phrases (like
Examples,API keys,transform), and outdated terms (likeX-Pack). This PR removes the least controversial items, but as @florent-leborgne mentions in #3536 (comment), we can probably eliminate a lot more.Generative AI disclosure