Update Elastic Managed integration documentation wording and links - #20987
Update Elastic Managed integration documentation wording and links#20987moxarth-rathod wants to merge 5 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.
There was a problem hiding this comment.
Thanks @andsel for highlighting this, I've reverted this change. It was unintentionally included as part of the bulk updates.
There was a problem hiding this comment.
This should be https://github.com/elastic/integrations/pull/19334, not the issue link.
🚀 Benchmarks reportTo see the full report comment with |
Co-authored-by: Tiago Queiroz <github@queiroz.life>
|
✅ All changelog entries have the correct PR link. |
|
🟢 Reviewed the latest commits 59aa0e9…3713c4b (7 commits) — nothing new beyond already posted comments.
🤖 AI-Generated Review | Vera Review Bot - v0.3.0 | 📚 Knowledge base: integration-skills
|
| {{/* If agentless is available for this integration, we'll want to include that here as well. | ||
| ### Agentless deployment | ||
| {{/* If Elastic Managed integration is available for this integration, we'll want to include that here as well. | ||
| ### Elastic Managed enabled integration | ||
|
|
||
| Agentless deployments are only supported in Elastic Serverless and Elastic Cloud environments. Agentless deployments provide a means to ingest data while avoiding the orchestration, management, and maintenance needs associated with standard ingest infrastructure. Using an agentless deployment makes manual agent deployment unnecessary, allowing you to focus on your data instead of the agent that collects it. | ||
| Elastic Managed integrations are only supported on Elastic Cloud Serverless and Elastic Cloud Hosted deployments. An Elastic Managed integration lets you ingest data from a cloud source while avoiding the orchestration, management, and maintenance associated with standard ingest infrastructure. Elastic runs the collector for you, so you can focus on your data instead of the infrastructure that collects it. | ||
|
|
||
| For more information, refer to [Agentless integrations](https://www.elastic.co/guide/en/serverless/current/security-agentless-integrations.html) and [Agentless integrations FAQ](https://www.elastic.co/guide/en/serverless/current/agentless-integration-troubleshooting.html) | ||
| For more information, refer to [Elastic Managed integrations](https://www.elastic.co/docs/manage-data/ingest/managed-integrations/managed-integrations) and the [Elastic Managed integrations FAQ](https://www.elastic.co/docs/manage-data/ingest/managed-integrations/managed-integrations-faq). | ||
| */}} |
There was a problem hiding this comment.
This documentation comes from the elastic-package repository when elastic-package create package commnad is used:
@moxarth-rathod Could you update this too in elastic-package repo? so new packages get the new documentation about Elastic Managed enabled integration
As a note, this will take effect in a future elastic-package release version, so there could be new packages with that previous documentation generated in the meantime.
There was a problem hiding this comment.
Just to keep a track of this change, I've opened an issue: elastic/elastic-package#3917
💛 Build succeeded, but was flaky
Failed CI StepsHistory
|
|
@moxarth-rathod - This PR has merge conflicts with the base branch. Please resolve them. |
Proposed commit message
Checklist
changelog.ymlfile.Related issues
release: ga#20751