Skip to content

[armis]: align the README with documentation guidelines - #22078

Merged
muskan-agarwal26 merged 5 commits into
elastic:mainfrom
muskan-agarwal26:armis-ga-release
Oct 30, 2026
Merged

muskan-agarwal26 merged 5 commits into
elastic:mainfrom
muskan-agarwal26:armis-ga-release

Conversation

@muskan-agarwal26

@muskan-agarwal26 muskan-agarwal26 commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

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

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

How to test this PR locally

elastic-package test

Related issues

@muskan-agarwal26
muskan-agarwal26 requested review from a team as code owners October 20, 2026 09:15
@github-actions

github-actions Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 3 warnings found

⚠️ Warnings (3): Fix when the suggestion improves clarity or correctness.
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.

@qcorporation qcorporation added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:armis Armis Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations] labels Oct 20, 2026
@infra-vault-gh-plugin-prod

Copy link
Copy Markdown

Pinging @elastic/security-service-integrations (Team:Security-Service Integrations)

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@muskan-agarwal26 muskan-agarwal26 changed the title [armis] Release as GA [armis]: release as GA and align the README with documentation guidelines Oct 21, 2026

@kcreddy kcreddy left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets not use Closes yet in the PR description. I'll sign-off on the issue instead after this PR is merged. Once we get PM sign-off you can close the issue.

Copilot AI balanced review requested due to automatic review settings October 28, 2026 09:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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

@mergify

mergify Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

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.

Comment thread packages/armis/changelog.yml Resolved
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

✅ All changelog entries have the correct PR link.

@vera-review-bot

Copy link
Copy Markdown
Contributor

Review summary

Issues found across the latest commits f5508bb — 1 low

Package-level:

  • 🔵 PR title and Proposed commit message still claim a GA release at 1.0.0, but the PR now bumps to 0.9.2

    Update the PR title and the Proposed commit message to match the 0.9.2 change, for example:

    [armis]: align the README with documentation guidelines
    
    Align the Armis README with the integration documentation guidelines
    and bump the package version to 0.9.2. 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.
    
Issues found across earlier commits 2786355 — 2 low
  • 🔵 Validation step 4 asks users to record stack versions and per-stream results, which reads as GA test evidence rather than setup guidance (link)

Package-level:

  • 🔵 Proposed commit message

    armis: release as GA and align the README with documentation guidelines
    
    Promote the Armis integration to GA by bumping the package version to
    1.0.0.
    
    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.
    
    Closes 17764
    

A new commit triggers another review — at most once every 15 minutes. I skip the PR while it's approved or has merge conflicts.

🤖 AI-Generated Review | Vera Review Bot - v0.4.3 | 📚 Knowledge base: integration-skills

⚠️ Automated review — verify suggestions before applying.

@kcreddy kcreddy left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@muskan-agarwal26, please change commit message and PR title accordingly before merging.

See #17764 (comment) for pending work.

@infra-vault-gh-plugin-prod

Copy link
Copy Markdown

💚 Build Succeeded

History

@muskan-agarwal26 muskan-agarwal26 changed the title [armis]: release as GA and align the README with documentation guidelines [armis]: align the README with documentation guidelines Oct 30, 2026
@muskan-agarwal26
muskan-agarwal26 merged commit 38fa6c6 into elastic:main Oct 30, 2026
16 checks passed
@muskan-agarwal26
muskan-agarwal26 deleted the armis-ga-release branch October 30, 2026 09:34
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

Package armis - 0.9.2 containing this change is available at https://epr.elastic.co/package/armis/0.9.2/

@kcreddy kcreddy mentioned this pull request Nov 3, 2026
23 tasks done
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:armis Armis Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

⌂ 换网址