Repository navigation
[armis]: align the README with documentation guidelines - #22078
Conversation
Elastic Docs Style Checker (Vale)Summary: 3 warnings found
|
| File | Line | Rule | Message |
|---|---|---|---|
| packages/armis/_dev/build/docs/README.md | 47 | Elastic.MenuArrowsBold | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
| packages/armis/_dev/build/docs/README.md | 47 | Elastic.MenuArrows | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
| packages/armis/_dev/build/docs/README.md | 47 | Elastic.MenuArrows | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
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.
|
Pinging @elastic/security-service-integrations (Team:Security-Service Integrations) |
🚀 Benchmarks reportTo see the full report comment with |
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are reported for the Armis 1.0.0 release and documentation updates.
No open issues 🎉
What changed in this PR
Promotes the Armis integration to GA as version 1.0.0 and expands its documentation to support deployment and operation. Data collection behavior remains unchanged.
Changes:
- Bumps the package version and records the GA release in the changelog.
- Documents API polling, supported use cases, deployment options, and configuration defaults.
- Adds validation steps, performance guidance, and input/API references to both README versions.
| File | Description |
|---|---|
packages/armis/manifest.yml |
Bumps the package version to 1.0.0. |
packages/armis/docs/README.md |
Expands the published setup, operation, and reference documentation. |
packages/armis/changelog.yml |
Records the GA release and documentation updates. |
packages/armis/_dev/build/docs/README.md |
Updates the source template to match the published README. |
Review effort: Balanced
|
This pull request does not currently match the merge queue conditions, so it cannot be queued from here. The box comes back if it matches again. |
|
✅ All changelog entries have the correct PR link. |
Review summaryIssues found across the latest commits f5508bb — 1 lowPackage-level:
Issues found across earlier commits 2786355 — 2 low
Package-level:
🤖 AI-Generated Review | Vera Review Bot - v0.4.3 | 📚 Knowledge base: integration-skills
|
There was a problem hiding this comment.
@muskan-agarwal26, please change commit message and PR title accordingly before merging.
See #17764 (comment) for pending work.
💚 Build Succeeded
History
|
|
Package armis - 0.9.2 containing this change is available at https://epr.elastic.co/package/armis/0.9.2/ |
Proposed commit message
Align the README with the integration documentation guidelines. Add
sections that explain how the CEL input polls the Armis API v1, the
supported use cases, deployment options, the configuration defaults
(interval, initial interval, and page size), validation steps, and
performance and scaling guidance. Also list the inputs and Armis API
endpoints the integration uses. The data collection behavior does not
change.
Checklist
changelog.ymlfile.How to test this PR locally
Related issues