[hpe_aruba_cx] Updated documentation and correcting the default tags#17383
[hpe_aruba_cx] Updated documentation and correcting the default tags#17383kgeller wants to merge 8 commits intoelastic:mainfrom
Conversation
…he default tags consistent
Vale Linting ResultsSummary: 30 warnings, 4 suggestions found
|
| 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.
🚀 Benchmarks reportTo see the full report comment with |
|
Pinging @elastic/integration-experience (Team:Integration-Experience) |
mjwolf
left a comment
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
tweaked this a bit to hopefully be more clear, wdyt?
Co-authored-by: Michael Wolf <michael.wolf@elastic.co>
Co-authored-by: Michael Wolf <michael.wolf@elastic.co>
💚 Build Succeeded
History
cc @kgeller |
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 verified that all data streams collect metrics or logs.changelog.ymlfile.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 practicesAuthor'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
cd packages/hpe_aruba_cxelastic-package buildelastic-package stack up -v -dRelated issues
Closes https://github.com/elastic/integration-experience/issues/451