Repository navigation
Update Elastic Managed integration documentation wording and links - #20987
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.
🚀 Benchmarks reportTo see the full report comment with |
|
Package ti_greynoise - 0.12.0 containing this change is available at https://epr.elastic.co/package/ti_greynoise/0.12.0/ |
|
Package ti_maltiverse - 1.13.0 containing this change is available at https://epr.elastic.co/package/ti_maltiverse/1.13.0/ |
|
Package ti_mandiant_advantage - 1.14.0 containing this change is available at https://epr.elastic.co/package/ti_mandiant_advantage/1.14.0/ |
|
Package ti_misp - 1.50.0 containing this change is available at https://epr.elastic.co/package/ti_misp/1.50.0/ |
|
Package ti_opencti - 2.19.0 containing this change is available at https://epr.elastic.co/package/ti_opencti/2.19.0/ |
|
Package ti_otx - 1.37.0 containing this change is available at https://epr.elastic.co/package/ti_otx/1.37.0/ |
|
Package ti_rapid7_threat_command - 2.15.0 containing this change is available at https://epr.elastic.co/package/ti_rapid7_threat_command/2.15.0/ |
|
Package ti_recordedfuture - 2.12.0 containing this change is available at https://epr.elastic.co/package/ti_recordedfuture/2.12.0/ |
|
Package ti_socradar_feeds - 0.4.0 containing this change is available at https://epr.elastic.co/package/ti_socradar_feeds/0.4.0/ |
|
Package ti_socradar_taxii - 0.6.0 containing this change is available at https://epr.elastic.co/package/ti_socradar_taxii/0.6.0/ |
|
Package ti_threatconnect - 2.8.0 containing this change is available at https://epr.elastic.co/package/ti_threatconnect/2.8.0/ |
|
Package ti_threatq - 1.43.0 containing this change is available at https://epr.elastic.co/package/ti_threatq/1.43.0/ |
|
Package tines - 1.20.0 containing this change is available at https://epr.elastic.co/package/tines/1.20.0/ |
|
Package trellix_epo_cloud - 1.19.0 containing this change is available at https://epr.elastic.co/package/trellix_epo_cloud/1.19.0/ |
|
Package trellix_epo_on_prem - 0.2.0 containing this change is available at https://epr.elastic.co/package/trellix_epo_on_prem/0.2.0/ |
|
Package trend_micro_vision_one - 2.14.0 containing this change is available at https://epr.elastic.co/package/trend_micro_vision_one/2.14.0/ |
|
Package vectra_rux - 0.8.0 containing this change is available at https://epr.elastic.co/package/vectra_rux/0.8.0/ |
|
Package withsecure_elements - 0.5.0 containing this change is available at https://epr.elastic.co/package/withsecure_elements/0.5.0/ |
|
Package wiz - 4.9.0 containing this change is available at https://epr.elastic.co/package/wiz/4.9.0/ |
|
Package workday - 0.7.0 containing this change is available at https://epr.elastic.co/package/workday/0.7.0/ |
|
Package xm_cyber - 0.7.0 containing this change is available at https://epr.elastic.co/package/xm_cyber/0.7.0/ |
|
Package zerofox - 1.33.0 containing this change is available at https://epr.elastic.co/package/zerofox/1.33.0/ |
|
Package zeronetworks - 1.23.0 containing this change is available at https://epr.elastic.co/package/zeronetworks/1.23.0/ |
|
Package zoom - 1.29.0 containing this change is available at https://epr.elastic.co/package/zoom/1.29.0/ |
|
Package zscaler_zia - 4.5.0 containing this change is available at https://epr.elastic.co/package/zscaler_zia/4.5.0/ |
…s docs (#4155) The README template emitted by `elastic-package create package` still described the agentless deployment mode as "Agentless deployment" and linked to the retired serverless guide pages. Replace that block with the "Elastic Managed enabled integration" text and links adopted in elastic/integrations#20987. The docagent postprocessor carries a copy of the same block, which it inserts when a package enables agentless and removes when it does not. Update that copy to match the template, and mark the new heading as an optional subsection in the structure validator. The postprocessor also matches the legacy "Agentless deployment" heading, since the LLM can carry it forward from an existing README. When agentless is disabled, every Elastic Managed or legacy section is removed. When it is enabled and the README has a legacy heading or more than one matching heading, they are all removed and the canonical block is inserted once, so the output never keeps the old text or ends up with two sections. That replacement is skipped when the README has no deploy section, since the canonical block could not be reinserted. Closes #3917
Proposed commit message
Checklist
changelog.ymlfile.Related issues
release: ga#20751