Skip to content
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

[DOC] Add new doc for grok processor #5019

Merged
merged 29 commits into from
Nov 6, 2023

Address tech feedback

bf81892
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Merged

[DOC] Add new doc for grok processor #5019

Address tech feedback
bf81892
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Oct 23, 2023 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (4)

_ingest-pipelines/processors/grok.md|9 col 3| [OpenSearch.HeadingCapitalization] 'Grok' is a heading and should be in sentence case.
_ingest-pipelines/processors/grok.md|11 col 184| [OpenSearch.Spelling] Error: unformatted. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_ingest-pipelines/processors/grok.md|25 col 4| [OpenSearch.HeadingCapitalization] 'Grok patterns' is a heading and should be in sentence case.
_ingest-pipelines/processors/grok.md|31 col 4| [OpenSearch.HeadingCapitalization] 'Configuration parameters' is a heading and should be in sentence case.

Filtered Findings (3653)

404.md|9 col 48| [OpenSearch.HeadingPunctuation] Don't use punctuation at the end of a heading.
404.md|11 col 96| [OpenSearch.DirectionAboveBelow] Use 'following or later' instead of 'below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
404.md|11 col 142| [OpenSearch.Please] Using 'please' is unnecessary. Remove.
_upgrade-to/snapshot-migrate.md|9 col 45| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore)'.
_upgrade-to/dashboards-upgrade-to.md|7 col 3| [OpenSearch.HeadingCapitalization] 'Migrating from Kibana OSS to OpenSearch Dashboards' is a heading and should be in sentence case.
_upgrade-to/index.md|20 col 101| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore)'.
_security-analytics/usage/detectors.md|8 col 3| [OpenSearch.HeadingCapitalization] 'Working with detectors' is a heading and should be in sentence case.
_security-analytics/usage/detectors.md|26 col 111| [OpenSearch.Spelling] Error: editig. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_security-analytics/usage/overview.md|8 col 3| [OpenSearch.HeadingCapitalization] 'The Overview page' is a heading and should be in sentence case.
_security-analytics/usage/index.md|11 col 3| [OpenSearch.HeadingCapitalization] 'Using Security Analytics' is a heading and should be in sentence case.
_security-analytics/security.md|8 col 3| [OpenSearch.HeadingCapitalization] 'OpenSearch Security for Security Analytics' is a heading and should be in sentence case.
_security-analytics/security.md|13 col 4| [OpenSearch.HeadingCapitalization] 'Security Analytics system indexes' is a heading and should be in sentence case.
_security-analytics/security.md|27 col 4| [OpenSearch.HeadingCapitalization] '(Advanced) Limit access by backend role' is a heading and should be in sentence case.
_security-analytics/security.md|96 col 305| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/access-control/document-level-security)'.
_security-analytics/security.md|96 col 416| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/access-control/field-level-security)'.
_security-analytics/usage/correlation-graph.md|8 col 3| [OpenSearch.HeadingCapitalization] 'Working with the correlation graph' is a heading and should be in sentence case.
_security-analytics/usage/correlation-graph.md|13 col 4| [OpenSearch.Spelling] Error: Acccessing. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_upgrade-to/upgrade-to.md|7 col 3| [OpenSearch.HeadingCapitalization] 'Migrating from Elasticsearch OSS to OpenSearch' is a heading and should be in sentence case.
_upgrade-to/upgrade-to.md|31 col 1| [OpenSearch.TableHeadings] 'Elasticsearch OSS version' is a table heading and should be in sentence case.
_upgrade-to/upgrade-to.md|41 col 4| [OpenSearch.HeadingCapitalization] 'Upgrade Elasticsearch OSS' is a heading and should be in sentence case.
_upgrade-to/upgrade-to.md|56 col 36| [OpenSearch.Spelling] Error: systemd. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_upgrade-to/upgrade-to.md|62 col 66| [OpenSearch.Inclusive] Use 'stop, end, clear, remove, or cancel' instead of 'kill' because the latter is an offensive term.
_upgrade-to/upgrade-to.md|72 col 221| [OpenSearch.Spelling] Error: colocated. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_upgrade-to/upgrade-to.md|76 col 36| [OpenSearch.Spelling] Error: systemd. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_upgrade-to/upgrade-to.md|97 col 47| [OpenSearch.SubstitutionsError] Use 'reenable' instead of 're-enable'.
_upgrade-to/upgrade-to.md|128 col 36| [OpenSearch.Spelling] Error: systemd. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_upgrade-to/upgrade-to.md|134 col 66| [OpenSearch.Inclusive] Use 'stop, end, clear, remove, or cancel' instead of 'kill' because the latter is an offensive term.
_upgrade-to/upgrade-to.md|179 col 47| [OpenSearch.SubstitutionsError] Use 'reenable' instead of 're-enable'.
_upgrade-to/upgrade-to.md|265 col 36| [OpenSearch.Spelling] Error: systemd. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_upgrade-to/upgrade-to.md|271 col 66| [OpenSearch.Inclusive] Use 'stop, end, clear, remove, or cancel' instead of 'kill' because the latter is an offensive term.
_upgrade-to/upgrade-to.md|281 col 47| [OpenSearch.SubstitutionsError] Use 'reenable' instead of 're-enable'.
_security-analytics/usage/findings.md|8 col 3| [OpenSearch.HeadingCapitalization] 'Working with findings' is a heading and should be in sentence case.
_security-analytics/usage/findings.md|17 col 4| [OpenSearch.HeadingCapitalization] 'The Findings graph' is a heading and should be in sentence case.
_security-analytics/usage/findings.md|44 col 4| [OpenSearch.HeadingCapitalization] 'The Findings list' is a heading and should be in sentence case.
_security-analytics/usage/alerts.md|8 col 3| [OpenSearch.HeadingCapitalization] 'Working with alerts' is a heading and should be in sentence case.
_security-analytics/usage/alerts.md|17 col 4| [OpenSearch.HeadingCapitalization] 'The Alerts graph' is a heading and should be in sentence case.
_security-analytics/usage/alerts.md|43 col 4| [OpenSearch.HeadingCapitalization] 'The Alerts list' is a heading and should be in sentence case.
_security-analytics/api-tools/mappings-api.md|13 col 4| [OpenSearch.HeadingCapitalization] 'Get Mappings View' is a heading and should be in sentence case.
_security-analytics/api-tools/mappings-api.md|26 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_security-analytics/api-tools/mappings-api.md|79 col 4| [OpenSearch.HeadingCapitalization] 'Create Mappings' is a heading and should be in sentence case.
_security-analytics/api-tools/mappings-api.md|81 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_security-analytics/api-tools/mappings-api.md|110 col 4| [OpenSearch.HeadingCapitalization] 'Get Mappings' is a heading and should be in sentence case.
_security-analytics/api-tools/mappings-api.md|112 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_security-analytics/api-tools/mappings-api.md|140 col 4| [OpenSearch.HeadingCapitalization] 'Update Mappings' is a heading and should be in sentence case.
_security-analytics/usage/rules.md|8 col 3| [OpenSearch.HeadingCapitalization] 'Working with detection rules' is a heading and should be in sentence case.
_security-analytics/usage/rules.md|48 col 6| [OpenSearch.HeadingCapitalization] 'The Visual Editor' is a heading and should be in sentence case.
_security-analytics/usage/rules.md|86 col 4| [OpenSearch.AdverbsOfTime] Don't use a comma after single-word adverbs of time at the beginning of a sentence in 'Then,'.
_security-analytics/usage/rules.md|128 col 6| [OpenSearch.HeadingCapitalization] 'The YAML Editor' is a heading and should be in sentence case.
_security-analytics/api-tools/index.md|11 col 3| [OpenSearch.HeadingCapitalization] 'API tools' is a heading and should be in sentence case.
_security-analytics/sec-analytics-config/custom-log-type.md|26 col 4| [OpenSearch.HeadingCapitalization] 'Log type API' is a heading and should be in sentence case.
_security-analytics/api-tools/alert-finding-api.md|14 col 4| [OpenSearch.HeadingCapitalization] 'Get Alerts' is a heading and should be in sentence case.
_security-analytics/api-tools/alert-finding-api.md|35 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_security-analytics/api-tools/alert-finding-api.md|86 col 4| [OpenSearch.HeadingCapitalization] 'Acknowledge Alerts' is a heading and should be in sentence case.
_security-analytics/api-tools/alert-finding-api.md|137 col 4| [OpenSearch.HeadingCapitalization] 'Get Findings' is a heading and should be in sentence case.
_security-analytics/api-tools/rule-api.md|13 col 4| [OpenSearch.HeadingCapitalization] 'Create Custom Rule' is a heading and should be in sentence case.
_security-analytics/api-tools/rule-api.md|21 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_security-analytics/api-tools/rule-api.md|122 col 4| [OpenSearch.HeadingCapitalization] 'Update Custom Rule (not forced)' is a heading and should be in sentence case.
_security-analytics/api-tools/rule-api.md|124 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_security-analytics/api-tools/rule-api.md|183 col 4| [OpenSearch.HeadingCapitalization] 'Update Custom Rule (forced)' is a heading and should be in sentence case.
_security-analytics/api-tools/rule-api.md|185 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_security-analytics/api-tools/rule-api.md|263 col 4| [OpenSearch.HeadingCapitalization] 'Search Pre-Packaged Rules' is a heading and should be in sentence case.
_security-analytics/api-tools/rule-api.md|265 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_security-analytics/api-tools/rule-api.md|358 col 4| [OpenSearch.HeadingCapitalization] 'Search Custom Rules' is a heading and should be in sentence case.
_security-analytics/api-tools/rule-api.md|360 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_security-analytics/api-tools/rule-api.md|455 col 4| [OpenSearch.HeadingCapitalization] 'Delete Custom Rule (not forced)' is a heading and should be in sentence case.
_security-analytics/api-tools/rule-api.md|457 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_security-analytics/api-tools/rule-api.md|486 col 4| [OpenSearch.HeadingCapitalization] 'Delete Custom Rule (forced)' is a heading and should be in sentence case.
_security-analytics/api-tools/detector-api.md|13 col 4| [OpenSearch.HeadingCapitalization] 'Create Detector API' is a heading and should be in sentence case.
_security-analytics/api-tools/detector-api.md|28 col 106| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_security-analytics/api-tools/detector-api.md|41 col 221| [OpenSearch.SubstitutionsError] Use 'for information about' instead of 'for information on'.
_security-analytics/api-tools/detector-api.md|47 col 118| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_security-analytics/api-tools/detector-api.md|55 col 129| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_security-analytics/api-tools/detector-api.md|219 col 4| [OpenSearch.HeadingCapitalization] 'Update Detector API' is a heading and should be in sentence case.
_security-analytics/api-tools/detector-api.md|234 col 110| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_security-analytics/api-tools/detector-api.md|344 col 4| [OpenSearch.HeadingCapitalization] 'Delete Detector API' is a heading and should be in sentence case.
_security-analytics/api-tools/detector-api.md|348 col 5| [OpenSearch.HeadingCapitalization] 'Path and HTTP methods' is a heading and should be in sentence case.
_security-analytics/api-tools/detector-api.md|371 col 4| [OpenSearch.HeadingCapitalization] 'Get Detector API' is a heading and should be in sentence case.
_security-analytics/api-tools/detector-api.md|375 col 5| [OpenSearch.HeadingCapitalization] 'Path and HTTP methods' is a heading and should be in sentence case.
_security-analytics/api-tools/detector-api.md|427 col 4| [OpenSearch.HeadingCapitalization] 'Search Detector API' is a heading and should be in sentence case.
_security-analytics/sec-analytics-config/index.md|11 col 3| [OpenSearch.HeadingCapitalization] 'Setting up Security Analytics' is a heading and should be in sentence case.
_security-analytics/sec-analytics-config/index.md|20 col 4| [OpenSearch.HeadingCapitalization] 'Navigate to Security Analytics' is a heading and should be in sentence case.
_security-analytics/sec-analytics-config/correlation-config.md|13 col 4| [OpenSearch.HeadingCapitalization] 'Configuring rules' is a heading and should be in sentence case.
_security-analytics/sec-analytics-config/log-types.md|21 col 131| [OpenSearch.Spelling] Error: unsecure. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_security-analytics/sec-analytics-config/log-types.md|33 col 389| [OpenSearch.Spelling] Error: SQi. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_security-analytics/sec-analytics-config/log-types.md|34 col 67| [OpenSearch.Spelling] Error: syslog. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
templates/API_TEMPLATE.md|8 col 3| [OpenSearch.HeadingCapitalization] 'Example API' is a heading and should be in sentence case.
templates/API_TEMPLATE.md|14 col 4| [OpenSearch.HeadingCapitalization] 'Path and HTTP methods' is a heading and should be in sentence case.
_security-analytics/index.md|13 col 3| [OpenSearch.HeadingCapitalization] 'About Security Analytics' is a heading and should be in sentence case.
_security-analytics/index.md|16 col 333| [OpenSearch.Spelling] Error: cyber. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_security-analytics/index.md|16 col 333| [OpenSearch.Cyber] Use 'cyber' as a prefix. Remove spaces or hyphens in 'cyber attacks'.
_security-analytics/sec-analytics-config/detectors-config.md|15 col 4| [OpenSearch.HeadingCapitalization] 'Step 1. Define a detector' is a heading and should be in sentence case.
_security-analytics/sec-analytics-config/detectors-config.md|53 col 4| [OpenSearch.HeadingCapitalization] 'Step 2. Set up alerts' is a heading and should be in sentence case.
_security-analytics/sec-analytics-config/detectors-config.md|109 col 244| [OpenSearch.Spelling] Error: OSMappings. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_security-analytics/sec-analytics-config/detectors-config.md|111 col 5| [OpenSearch.HeadingCapitalization] 'Amazon Security Lake logs' is a heading and should be in sentence case.
_security-analytics/sec-analytics-config/detectors-config.md|115 col 222| [OpenSearch.Spelling] Error: dns. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
API_STYLE_GUIDE.md|1 col 3| [OpenSearch.HeadingCapitalization] 'API Style Guide' is a heading and should be in sentence case.
API_STYLE_GUIDE.md|42 col 4| [OpenSearch.HeadingCapitalization] 'API name' is a heading and should be in sentence case.
API_STYLE_GUIDE.md|58 col 5| [OpenSearch.HeadingCapitalization] 'Path and HTTP methods' is a heading and should be in sentence case.
API_STYLE_GUIDE.md|91 col 177| [OpenSearch.Spelling] Error: informat. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_install-and-configure/install-opensearch/ansible.md|21 col 4| [OpenSearch.HeadingCapitalization] 'Configuration' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/ansible.md|23 col 26| [Vale.Terms] Use 'Ansible' instead of 'ansible'.
_install-and-configure/install-opensearch/ansible.md|53 col 4| [OpenSearch.HeadingCapitalization] 'Run OpenSearch and OpenSearch Dashboards using Ansible playbook' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/rpm.md|16 col 3| [OpenSearch.HeadingCapitalization] 'RPM' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/rpm.md|37 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_install-and-configure/install-opensearch/rpm.md|78 col 5| [OpenSearch.HeadingCapitalization] 'Install OpenSearch from a YUM repository' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/rpm.md|138 col 4| [OpenSearch.HeadingCapitalization] 'Step 2: (Optional) Test OpenSearch' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/rpm.md|144 col 354| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/configuration/yaml)'.
_install-and-configure/install-opensearch/rpm.md|171 col 55| [Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.
_install-and-configure/install-opensearch/rpm.md|171 col 55| [OpenSearch.Spelling] Error: opensearch. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_install-and-configure/install-opensearch/rpm.md|260 col 5| [OpenSearch.HeadingCapitalization] 'Configure TLS' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/rpm.md|310 col 93| [OpenSearch.AcronymParentheses] 'CN': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_install-and-configure/install-opensearch/rpm.md|349 col 15| [OpenSearch.AcronymParentheses] 'CN': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_install-and-configure/install-opensearch/rpm.md|366 col 5| [OpenSearch.HeadingCapitalization] 'Configure a user' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/rpm.md|479 col 5| [OpenSearch.HeadingCapitalization] 'Manual upgrade with RPM' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/rpm.md|489 col 5| [OpenSearch.HeadingCapitalization] 'YUM' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/helm.md|25 col 70| [OpenSearch.AcronymParentheses] 'README': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_install-and-configure/install-opensearch/helm.md|36 col 22| [Vale.Terms] Use 'Helm' instead of 'helm'.
_install-and-configure/install-opensearch/windows.md|31 col 48| [OpenSearch.Spelling] Error: _version. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_install-and-configure/install-opensearch/windows.md|34 col 4| [OpenSearch.HeadingCapitalization] 'Step 2: (Optional) Test OpenSearch' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/windows.md|45 col 354| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/configuration/yaml)'.
_install-and-configure/install-opensearch/windows.md|195 col 72| [OpenSearch.Simple] Don't use 'simply' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_install-and-configure/install-opensearch/windows.md|253 col 76| [OpenSearch.Spelling] Error: _version. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_install-and-configure/install-opensearch/windows.md|254 col 35| [OpenSearch.Spelling] Error: dialogs. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_install-and-configure/install-dashboards/rpm.md|16 col 3| [OpenSearch.HeadingCapitalization] 'Run OpenSearch Dashboards using RPM Package Manager (RPM)' is a heading and should be in sentence case.
_install-and-configure/install-dashboards/rpm.md|16 col 55| [OpenSearch.HeadingAcronyms] '(RPM)': Don't define acronyms in headings.
_install-and-configure/install-dashboards/rpm.md|20 col 4| [OpenSearch.HeadingCapitalization] 'Install OpenSearch Dashboards from a package' is a heading and should be in sentence case.
_install-and-configure/install-dashboards/rpm.md|55 col 4| [OpenSearch.HeadingCapitalization] 'Install OpenSearch Dashboards from a local YUM repository' is a heading and should be in sentence case.
_install-and-configure/install-dashboards/docker.md|11 col 3| [OpenSearch.HeadingCapitalization] 'Run OpenSearch Dashboards using Docker' is a heading and should be in sentence case.
_install-and-configure/install-dashboards/docker.md|19 col 4| [OpenSearch.Simple] Don't use 'Just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_install-and-configure/install-dashboards/tar.md|10 col 3| [OpenSearch.HeadingCapitalization] 'Run OpenSearch Dashboards using the tarball' is a heading and should be in sentence case.
_install-and-configure/install-dashboards/windows.md|10 col 3| [OpenSearch.HeadingCapitalization] 'Run OpenSearch Dashboards on Windows' is a heading and should be in sentence case.
_install-and-configure/install-dashboards/windows.md|17 col 59| [OpenSearch.Spelling] Error: _version. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_install-and-configure/install-dashboards/windows.md|53 col 83| [OpenSearch.Simple] Don't use 'simply' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_install-and-configure/install-opensearch/docker.md|15 col 105| [Vale.Terms] Use 'macOS' instead of 'MacOS'.
_install-and-configure/install-opensearch/docker.md|154 col 5| [OpenSearch.HeadingCapitalization] 'Sample docker-' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/docker.md|154 col 12| [Vale.Terms] Use 'Docker' instead of 'docker'.
_install-and-configure/install-opensearch/docker.md|225 col 327| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_install-and-configure/install-opensearch/docker.md|261 col 4| [OpenSearch.HeadingCapitalization] 'Configure OpenSearch' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/docker.md|282 col 44| [Vale.Terms] Use 'Docker' instead of 'docker'.
_install-and-configure/install-opensearch/docker.md|302 col 5| [OpenSearch.HeadingCapitalization] 'Sample Docker Compose file for development' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/docker.md|379 col 5| [OpenSearch.HeadingCapitalization] 'Configuring basic security settings' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/docker.md|381 col 174| [Vale.Terms] Use 'Docker' instead of 'docker'.
_install-and-configure/install-opensearch/docker.md|406 col 274| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/configuration/tls)'.
_install-and-configure/install-opensearch/docker.md|454 col 5| [OpenSearch.HeadingCapitalization] 'Working with plugins' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/docker.md|490 col 4| [Vale.Terms] Use 'Performance Analyzer' instead of 'Performance analyzer'.
_install-and-configure/install-opensearch/tar.md|49 col 4| [OpenSearch.HeadingCapitalization] 'Step 2: Configure important system settings' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/tar.md|75 col 4| [OpenSearch.HeadingCapitalization] 'Step 3: (Optional) Test OpenSearch' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/tar.md|86 col 348| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/configuration/yaml)'.
_install-and-configure/install-opensearch/tar.md|290 col 5| [OpenSearch.HeadingCapitalization] 'Configure TLS' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/tar.md|334 col 88| [OpenSearch.AcronymParentheses] 'CN': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_install-and-configure/install-opensearch/tar.md|368 col 15| [OpenSearch.AcronymParentheses] 'CN': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_install-and-configure/install-opensearch/tar.md|385 col 5| [OpenSearch.HeadingCapitalization] 'Configure a user' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/tar.md|498 col 38| [OpenSearch.Spelling] Error: systemd. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_install-and-configure/install-opensearch/tar.md|502 col 218| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/rpm)'.
_install-and-configure/install-dashboards/index.md|34 col 4| [OpenSearch.HeadingCapitalization] 'Configuration' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/index.md|24 col 1| [OpenSearch.TableHeadings] 'OS' is a table heading and should be in sentence case.
_install-and-configure/install-opensearch/index.md|40 col 1| [OpenSearch.TableHeadings] 'OpenSearch Version' is a table heading and should be in sentence case.
_install-and-configure/install-opensearch/index.md|40 col 22| [OpenSearch.TableHeadings] 'Compatible Java Versions' is a table heading and should be in sentence case.
_install-and-configure/install-opensearch/index.md|40 col 49| [OpenSearch.TableHeadings] 'Bundled Java Version' is a table heading and should be in sentence case.
_install-and-configure/install-opensearch/index.md|42 col 3| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_install-and-configure/install-opensearch/index.md|46 col 52| [OpenSearch.AcronymParentheses] 'SE': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_install-and-configure/install-opensearch/index.md|51 col 4| [OpenSearch.HeadingCapitalization] 'Network requirements' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/index.md|80 col 13| [Vale.Terms] Use 'Docker' instead of 'docker'.
_install-and-configure/install-opensearch/index.md|86 col 112| [OpenSearch.Spelling] Error: Hotspot. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_install-and-configure/install-dashboards/helm.md|10 col 3| [OpenSearch.HeadingCapitalization] 'Run OpenSearch Dashboards using Helm' is a heading and should be in sentence case.
_install-and-configure/install-dashboards/helm.md|57 col 4| [OpenSearch.HeadingCapitalization] 'Install OpenSearch Dashboards using Helm' is a heading and should be in sentence case.
_install-and-configure/install-dashboards/tls.md|10 col 3| [OpenSearch.HeadingCapitalization] 'Configure TLS for OpenSearch Dashboards' is a heading and should be in sentence case.
_install-and-configure/install-dashboards/tls.md|16 col 257| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_install-and-configure/install-dashboards/debian.md|18 col 4| [OpenSearch.HeadingCapitalization] 'Installing OpenSearch Dashboards from a package' is a heading and should be in sentence case.
_install-and-configure/install-dashboards/debian.md|28 col 49| [OpenSearch.Spelling] Error: systemd. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_install-and-configure/install-dashboards/debian.md|66 col 4| [OpenSearch.HeadingCapitalization] 'Installing OpenSearch Dashboards from an APT repository' is a heading and should be in sentence case.
_install-and-configure/install-dashboards/plugins.md|10 col 3| [OpenSearch.HeadingCapitalization] 'Managing OpenSearch Dashboards plugins' is a heading and should be in sentence case.
_install-and-configure/install-dashboards/plugins.md|33 col 3| [OpenSearch.TableHeadings] 'Plugin Name' is a table heading and should be in sentence case.
_install-and-configure/install-dashboards/plugins.md|33 col 17| [OpenSearch.TableHeadings] 'Repository' is a table heading and should be in sentence case.
_install-and-configure/install-dashboards/plugins.md|33 col 30| [OpenSearch.TableHeadings] 'Earliest Available Version' is a table heading and should be in sentence case.
_install-and-configure/install-dashboards/plugins.md|39 col 29| [Vale.Terms] Use 'Gantt' instead of 'gantt'.
_install-and-configure/index.md|12 col 112| [Vale.Terms] Use 'macOS' instead of 'MacOS'.
_install-and-configure/upgrade-opensearch/appendix/index.md|18 col 48| [OpenSearch.Please] Using 'please' is unnecessary. Remove.
_install-and-configure/install-opensearch/debian.md|37 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_install-and-configure/install-opensearch/debian.md|95 col 5| [OpenSearch.HeadingCapitalization] 'Install OpenSearch from an APT repository' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/debian.md|166 col 4| [OpenSearch.HeadingCapitalization] 'Step 2: (Optional) Test OpenSearch' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/debian.md|172 col 354| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security-plugin/configuration/yaml)'.
_install-and-configure/install-opensearch/debian.md|291 col 5| [OpenSearch.HeadingCapitalization] 'Configure TLS' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/debian.md|341 col 93| [OpenSearch.AcronymParentheses] 'CN': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_install-and-configure/install-opensearch/debian.md|356 col 58| [Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.
_install-and-configure/install-opensearch/debian.md|356 col 58| [OpenSearch.Spelling] Error: opensearch. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_install-and-configure/install-opensearch/debian.md|380 col 15| [OpenSearch.AcronymParentheses] 'CN': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_install-and-configure/install-opensearch/debian.md|397 col 5| [OpenSearch.HeadingCapitalization] 'Configure a user' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/debian.md|512 col 5| [OpenSearch.HeadingCapitalization] 'Manual upgrade with DPKG' is a heading and should be in sentence case.
_install-and-configure/install-opensearch/debian.md|522 col 5| [OpenSearch.HeadingCapitalization] 'APT-GET' is a heading and should be in sentence case.
_install-and-configure/configuration.md|10 col 3| [OpenSearch.HeadingCapitalization] 'Configuring OpenSearch' is a heading and should be in sentence case.
_install-and-configure/configuration.md|24 col 4| [OpenSearch.HeadingCapitalization] 'Update cluster settings using the API' is a heading and should be in sentence case.
_install-and-configure/configuration.md|47 col 22| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_install-and-configure/configuration.md|76 col 4| [OpenSearch.HeadingCapitalization] 'Configuration file' is a heading and should be in sentence case.
_install-and-configure/configuration.md|94 col 5| [OpenSearch.HeadingCapitalization] '(Optional) CORS header configuration' is a heading and should be in sentence case.
_install-and-configure/configuration.md|95 col 207| [OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'machine. Use'.
_install-and-configure/configuration.md|95 col 374| [OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'locally. Add'.
... (Too many findings. Dropped some findings)

Annotations

Check failure on line 9 in _ingest-pipelines/processors/grok.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _ingest-pipelines/processors/grok.md#L9

[OpenSearch.HeadingCapitalization] 'Grok' is a heading and should be in sentence case.
Raw output
{"message": "[OpenSearch.HeadingCapitalization] 'Grok' is a heading and should be in sentence case.", "location": {"path": "_ingest-pipelines/processors/grok.md", "range": {"start": {"line": 9, "column": 3}}}, "severity": "ERROR"}

Check failure on line 11 in _ingest-pipelines/processors/grok.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _ingest-pipelines/processors/grok.md#L11

[OpenSearch.Spelling] Error: unformatted. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: unformatted. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_ingest-pipelines/processors/grok.md", "range": {"start": {"line": 11, "column": 184}}}, "severity": "ERROR"}

Check failure on line 25 in _ingest-pipelines/processors/grok.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _ingest-pipelines/processors/grok.md#L25

[OpenSearch.HeadingCapitalization] 'Grok patterns' is a heading and should be in sentence case.
Raw output
{"message": "[OpenSearch.HeadingCapitalization] 'Grok patterns' is a heading and should be in sentence case.", "location": {"path": "_ingest-pipelines/processors/grok.md", "range": {"start": {"line": 25, "column": 4}}}, "severity": "ERROR"}

Check failure on line 31 in _ingest-pipelines/processors/grok.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _ingest-pipelines/processors/grok.md#L31

[OpenSearch.HeadingCapitalization] 'Configuration parameters' is a heading and should be in sentence case.
Raw output
{"message": "[OpenSearch.HeadingCapitalization] 'Configuration parameters' is a heading and should be in sentence case.", "location": {"path": "_ingest-pipelines/processors/grok.md", "range": {"start": {"line": 31, "column": 4}}}, "severity": "ERROR"}