Skip to content

[Arista NGFW] update README using docs generation tool - #17272

Merged
vinit-chauhan merged 8 commits into
elastic:mainfrom
vinit-chauhan:arista_ngfw-update_documentation
Feb 19, 2026
Merged

vinit-chauhan merged 8 commits into
elastic:mainfrom
vinit-chauhan:arista_ngfw-update_documentation

Conversation

@vinit-chauhan

Copy link
Copy Markdown
Contributor

Proposed commit message

[arista_ngfw] added knowledge_base file and generated README using llm based tooling

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

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Screenshots

image

@vinit-chauhan vinit-chauhan self-assigned this Feb 5, 2026
@vinit-chauhan vinit-chauhan added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:arista_ngfw Arista NG Firewall (Community supported) Team:Integration-Experience Security Integrations Integration Experience [elastic/integration-experience] labels Feb 5, 2026

### Elastic Prerequisites
- **Elastic Agent:** An active Elastic Agent must be installed and enrolled in a policy via Fleet.
- **Elastic Stack:** Recommended version 8.11.0 or later for full dashboard and field mapping support.

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.

We don't need the stack version in this file

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The generator reads the manifest.yml and it adds the minimum kibana version from there, and it would be present in other integrations as well. I think this would give good context for README generator.

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.

The latest version of the generator shouldn't be reading or including the kibana version. There are instructions to exclude it, and the tools shouldn't read it. It does include it sometimes anyways.

I think it's better not to include here, because then we'd need to update the version number in more places when it's changed.

The Arista NG Firewall integration for Elastic enables you to collect and analyze logs and metrics from Arista NG Firewall (formerly Untangle). By ingesting event-driven logs and statistics into the Elastic Stack, you'll gain deep visibility into network security, traffic patterns, and system performance in real-time.

## Supported Event types:
This integration facilitates:

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.

This section duplicated the supported use cases section below

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Feb 9, 2026 •

Copy link
Copy Markdown
Contributor

Vale Linting Results

Summary: 4 warnings, 4 suggestions found

⚠️ Warnings (4)
File Line Rule Message
packages/arista_ngfw/docs/README.md 190 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/arista_ngfw/docs/README.md 212 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/arista_ngfw/docs/README.md 232 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/arista_ngfw/docs/knowledge_base/service_info.md 139 Elastic.DontUse Don't use 'and/or'.
💡 Suggestions (4)
File Line Rule Message
packages/arista_ngfw/_dev/build/docs/README.md 41 Elastic.FirstPerson Avoid first-person pronouns such as ' I '.
packages/arista_ngfw/_dev/build/docs/README.md 55 Elastic.FirstPerson Avoid first-person pronouns such as ' I '.
packages/arista_ngfw/docs/README.md 41 Elastic.FirstPerson Avoid first-person pronouns such as ' I '.
packages/arista_ngfw/docs/README.md 55 Elastic.FirstPerson Avoid first-person pronouns such as ' I '.

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.

vinit-chauhan and others added 2 commits February 9, 2026 16:12
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@vinit-chauhan
vinit-chauhan marked this pull request as ready for review February 9, 2026 21:51
@vinit-chauhan
vinit-chauhan requested a review from a team as a code owner February 9, 2026 21:51
@elasticmachine

Copy link
Copy Markdown

Pinging @elastic/integration-experience (Team:Integration-Experience)

@mjwolf mjwolf added the enhancement New feature or request label Feb 10, 2026
@vinit-chauhan

Copy link
Copy Markdown
Contributor Author

/test

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@elasticmachine

Copy link
Copy Markdown

💚 Build Succeeded

History

cc @vinit-chauhan

@vinit-chauhan
vinit-chauhan merged commit c73f316 into elastic:main Feb 19, 2026
11 checks passed
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

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

navnit-elastic pushed a commit to navnit-elastic/integrations that referenced this pull request Mar 2, 2026
* update README using docs generation tool

* update changelog

* Remove duplicate content from arista_ngfw documentation

* Fix Vale linting issues in arista_ngfw documentation
@vinit-chauhan
vinit-chauhan deleted the arista_ngfw-update_documentation branch April 1, 2026 23:58
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:arista_ngfw Arista NG Firewall (Community supported) Team:Integration-Experience Security Integrations Integration Experience [elastic/integration-experience]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

⌂ 换网址