Skip to content

[hpe_aruba_cx] Updated documentation and correcting the default tags#17383

Open
kgeller wants to merge 8 commits intoelastic:mainfrom
kgeller:docs-generation-hpe-aruba-cx
Open

[hpe_aruba_cx] Updated documentation and correcting the default tags#17383
kgeller wants to merge 8 commits intoelastic:mainfrom
kgeller:docs-generation-hpe-aruba-cx

Conversation

@kgeller
Copy link
Contributor

@kgeller kgeller commented Feb 11, 2026

Proposed commit message

This PR contains the addition of a service_info, freshly generated docs, and a tiny fix to make the default tags consistent across the inputs.

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 Note

I used the LLM tools to generate the service_info and readme, but I manually added the tables of Aruba event type -> field mappings back into the readme's at the bottom under references under a new collapsible.

How to test this PR locally

  1. Check out the branch
  2. cd packages/hpe_aruba_cx
  3. elastic-package build
  4. elastic-package stack up -v -d
  5. Preview the docs in local Kibana

Related issues

Closes https://github.com/elastic/integration-experience/issues/451

@kgeller kgeller self-assigned this Feb 11, 2026
@kgeller kgeller added enhancement New feature or request Integration:hpe_aruba_cx HPE Aruba CX Team:Integration-Experience Security Integrations Integration Experience [elastic/integration-experience] labels Feb 11, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2026

Vale Linting Results

Summary: 30 warnings, 4 suggestions found

⚠️ Warnings (30)
File Line Rule Message
packages/hpe_aruba_cx/_dev/build/docs/README.md 48 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/_dev/build/docs/README.md 67 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/_dev/build/docs/README.md 75 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/_dev/build/docs/README.md 77 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/_dev/build/docs/README.md 87 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/hpe_aruba_cx/_dev/build/docs/README.md 95 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/_dev/build/docs/README.md 110 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/hpe_aruba_cx/_dev/build/docs/README.md 163 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/README.md 48 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/README.md 67 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/README.md 75 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/README.md 77 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/README.md 87 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/hpe_aruba_cx/docs/README.md 95 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/README.md 110 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/hpe_aruba_cx/docs/README.md 163 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/README.md 211 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/README.md 224 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/README.md 246 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/hpe_aruba_cx/docs/README.md 266 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/knowledge_base/service_info.md 56 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/knowledge_base/service_info.md 74 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/hpe_aruba_cx/docs/knowledge_base/service_info.md 95 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/hpe_aruba_cx/docs/knowledge_base/service_info.md 104 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/knowledge_base/service_info.md 107 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/knowledge_base/service_info.md 118 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/knowledge_base/service_info.md 120 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/hpe_aruba_cx/docs/knowledge_base/service_info.md 130 Elastic.EndPuntuaction Don't end headings with punctuation.
packages/hpe_aruba_cx/docs/knowledge_base/service_info.md 155 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/hpe_aruba_cx/docs/knowledge_base/service_info.md 156 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
💡 Suggestions (4)
File Line Rule Message
packages/hpe_aruba_cx/_dev/build/docs/README.md 150 Elastic.WordChoice Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI.
packages/hpe_aruba_cx/docs/README.md 150 Elastic.WordChoice Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI.
packages/hpe_aruba_cx/docs/README.md 1749 Elastic.WordChoice Consider using 'open' instead of 'Launch', unless the term is in the UI.
packages/hpe_aruba_cx/docs/README.md 2516 Elastic.WordChoice Consider using 'start, run' instead of 'boot', unless the term is in the UI.

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.

@elastic-vault-github-plugin-prod

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@kgeller kgeller marked this pull request as ready for review February 11, 2026 20:08
@kgeller kgeller requested a review from a team as a code owner February 11, 2026 20:08
@elasticmachine
Copy link

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

@andrewkroh andrewkroh added the documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. label Feb 11, 2026
Copy link
Contributor

@mjwolf mjwolf left a comment

Choose a reason for hiding this comment

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

Thanks for working on this! I think it looks good, there are just a few small things to change. There's also some linter suggestions you could make (you don't need to change the generated content)


If you prefer to collect logs from a file:

1. Ensure the Elastic Agent has read permissions for the directory containing the AOS-CX logs.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think here it should be more clear that you need to set up log export onto the elastic-agent host first, so that user's don't expect that they can read files from the appliance directly

Copy link
Contributor Author

Choose a reason for hiding this comment

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

tweaked this a bit to hopefully be more clear, wdyt?

@kgeller kgeller requested a review from mjwolf February 13, 2026 16:45
@elasticmachine
Copy link

💚 Build Succeeded

History

cc @kgeller

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:hpe_aruba_cx HPE Aruba CX Team:Integration-Experience Security Integrations Integration Experience [elastic/integration-experience]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants