Update Elastic Managed integration documentation wording and links - #20987
Update Elastic Managed integration documentation wording and links#20987moxarth-rathod wants to merge 2 commits into
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Pinging @elastic/security-service-integrations (Team:Security-Service Integrations) |
Elastic Docs Style Checker (Vale)Summary: 9 warnings, 9 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 50 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 50 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'that is' instead of 'i.e'. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 148 | Elastic.MenuArrowsBold | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 148 | Elastic.MenuArrows | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 156 | Elastic.MenuArrowsBold | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 156 | Elastic.MenuArrows | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 187 | Elastic.DontUse | Don't use 'please'. Choose a more precise or reader-focused term. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 188 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 188 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
💡 Suggestions (9): Optional style improvements. Apply when helpful.
| File | Line | Rule | Message |
|---|---|---|---|
| packages/tenable_sc/_dev/build/docs/README.md | 26 | Elastic.Wordiness | Consider using 'per' instead of 'as per'. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 26 | Elastic.Versions | Use 'and later' instead of 'and newer' when referring to versions. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 90 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 100 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 112 | Elastic.Wordiness | Consider using 'all' instead of 'all of '. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 112 | Elastic.Versions | Use 'earlier versions' instead of 'older versions' when referring to versions. |
| packages/ti_rapid7_threat_command/_dev/build/docs/README.md | 134 | Elastic.Wordiness | Consider using 'per' instead of 'as per'. |
| packages/ti_socradar_feeds/_dev/build/docs/README.md | 32 | Elastic.Semicolons | Use semicolons sparingly. Consider splitting the sentence or using a comma or conjunction. |
| packages/ti_socradar_taxii/_dev/build/docs/README.md | 32 | Elastic.Semicolons | Use semicolons sparingly. Consider splitting the sentence or using a comma or conjunction. |
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.
| - description: Fix status colour mappings in Node Health and Pipeline Health dashboards so that red/yellow/green/unknown statuses render with correct colours using the Borealis palette. | ||
| type: bugfix | ||
| link: https://github.com/elastic/integrations/issues/18627 | ||
| link: https://github.com/elastic/integrations/pull/18627 |
There was a problem hiding this comment.
@moxarth-rathod
#18627 is the issue that's solved by #19334. So this change seems not good.
|
✅ All changelog entries have the correct PR link. |
|
🟢 Reviewed the latest commits 9dc769f — nothing new beyond already posted comments.
🤖 AI-Generated Review | Vera Review Bot - v0.3.0 | 📚 Knowledge base: integration-skills
|
|
@moxarth-rathod - This PR has merge conflicts with the base branch. Please resolve them. |
🚀 Benchmarks reportTo see the full report comment with |
| tags: [forwarded] | ||
| agent: | ||
| base_image: systemd # Related issue: https://github.com/elastic/integrations/issues/10998 | ||
| base_image: systemd # Related issue: https://github.com/elastic/integrations/pull/10998 |
There was a problem hiding this comment.
That link is from an issue, not a PR. If you follow the new link it redirects to the old one.
| base_image: systemd # Related issue: https://github.com/elastic/integrations/pull/10998 | |
| base_image: systemd # Related issue: https://github.com/elastic/integrations/issues/10998 |
Proposed commit message
Checklist
changelog.ymlfile.Related issues
release: ga#20751