Repository navigation
[Arista NGFW] update README using docs generation tool - #17272
Conversation
|
|
||
| ### 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. |
There was a problem hiding this comment.
We don't need the stack version in this file
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
This section duplicated the supported use cases section below
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Vale Linting ResultsSummary: 4 warnings, 4 suggestions found
|
| 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.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
Pinging @elastic/integration-experience (Team:Integration-Experience) |
|
/test |
🚀 Benchmarks reportTo see the full report comment with |
💚 Build Succeeded
History
|
|
Package arista_ngfw - 1.6.0 containing this change is available at https://epr.elastic.co/package/arista_ngfw/1.6.0/ |
* update README using docs generation tool * update changelog * Remove duplicate content from arista_ngfw documentation * Fix Vale linting issues in arista_ngfw documentation
Proposed commit message
[arista_ngfw] added knowledge_base file and generated README using llm based tooling
Checklist
changelog.ymlfile.Author's Checklist
How to test this PR locally
Related issues
Screenshots