Diagnostics privacy disclaimer#6229
Merged
stefnestor merged 5 commits intoelastic:mainfrom May 7, 2026
Merged
Conversation
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
Contributor
Vale Linting ResultsSummary: 1 warning, 6 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| troubleshoot/deployments/cloud-enterprise/run-ece-diagnostics-tool.md | 60 | Elastic.MenuArrows | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
💡 Suggestions (6)
| File | Line | Rule | Message |
|---|---|---|---|
| troubleshoot/deployments/cloud-enterprise/run-ece-diagnostics-tool.md | 60 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/elasticsearch/diagnostic.md | 31 | Elastic.Versions | Use 'or later' instead of 'or higher' when referring to versions. |
| troubleshoot/index.md | 73 | Elastic.FirstPerson | Use caution when using first-person pronouns such as 'my.' |
| troubleshoot/ingest/logstash/diagnostic.md | 26 | Elastic.Versions | Use 'or later' instead of 'or higher' when referring to versions. |
| troubleshoot/kibana/capturing-diagnostics.md | 23 | Elastic.Repetition | "this" is repeated. |
| troubleshoot/kibana/capturing-diagnostics.md | 32 | Elastic.Versions | Use 'or later' instead of 'or higher' when referring to versions. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: Good. The standardized privacy note is consistently worded across all seven files. The updated warning in
troubleshoot/index.mdis clearer than the original. - Jargon: One issue —
ECKis used without expansion on first use in the newrun-eck-diagnostics.mdintro paragraph. See inline comment. - Frontmatter and applies_to:
troubleshoot/index.mdis missing anapplies_toblock entirely (pre-existing gap, but this PR edits the file). All other changed files haveapplies_topresent. - Content type fit: Changes are appropriate for troubleshooting pages. The heading demotion of
Working with supportfrom##to###(making it a sub-section ofContact us) is structurally sound. - Parent issue satisfaction: Not applicable — this is a cross-pollination/cleanup PR with no linked parent issue.
Nits
troubleshoot/index.md:107— Double space beforeAny uploads(see inline comment).
Notes
- Vale is not installed in this environment; style review was performed manually using the Elastic style guide rules.
troubleshoot/index.mdfrontmatter lacksapplies_toentirely. Since the PR touches this file, consider addingapplies_to(for examplestack: ga/serverless: ga, or the relevant deployment keys) to bring it into compliance with the mandatory frontmatter requirement.
Generated by Docs review agent for issue #6229 · ● 455.7K
|
|
||
| :::{warning} | ||
| Diagnostics and logs mainly emit product metadata and settings, but they may expose sensitive data which needs to be redacted before being shared outside of your organization. Refer to each product's diagnostics page for information on sanitizing output. | ||
| Diagnostics and logs mainly emit product metadata and settings. They are privacy-redacted as much as possible, but may still contain sensitive data which needs to be redacted before being shared outside of your organization. We therefore recommend against uploading these outputs to public forums. Any uploads to the [Elastic Support Portal](https://support.elastic.co) are treated according to the [Elastic Privacy Statement](https://www.elastic.co/legal/privacy-statement). Refer to each product's diagnostics page for information on sanitizing output. |
Contributor
There was a problem hiding this comment.
Double space introduced in this edit. There are two spaces between public forums. and Any uploads — remove the extra space.
| ::: | ||
|
|
||
| `eck-diagnostics` is a stand-alone command line tool to create a diagnostic archive to help troubleshoot issues with ECK. | ||
| ECK diagnostics is a stand-alone command line tool that you can run on hosts where the ECK operator is installed. It collects logs and metrics, and stores everything into an archive file that can be provided to [Elastic support](/troubleshoot/index.md#troubleshoot-work-with-support) for troubleshooting and investigation purposes. |
Contributor
There was a problem hiding this comment.
Jargon: ECK not expanded on first use.
The new intro paragraph uses "ECK" twice as a bare abbreviation without spelling it out. Per the jargon guide, spell out on first use in the page body.
Suggested rewrite:
Elastic Cloud on Kubernetes (ECK) diagnostics is a stand-alone command line tool that you can run on hosts where the ECK operator is installed. It collects logs and metrics, and stores everything into an archive file that can be provided to Elastic support for troubleshooting and investigation purposes.
theletterf
approved these changes
May 4, 2026
shainaraskas
reviewed
May 4, 2026
shainaraskas
reviewed
May 4, 2026
Member
Author
|
Cheers, both! 🙇♀️ |
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
3 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.
Summary
👋 howdy, team! Mini PR to cross-pollinate our diagnostic sensitive data & privacy statement disclaimers across the different diagnostic pages. Also took the moment to standardize the diagnostic intro paragraphs a bit (and remove AutoOps disclaimers from platform-level which it does not monitor, only ES).
Generative AI disclosure