-
Notifications
You must be signed in to change notification settings - Fork 540
[hpe_aruba_cx] Updated documentation and correcting the default tags #17383
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kgeller
wants to merge
3
commits into
elastic:main
Choose a base branch
from
kgeller:docs-generation-hpe-aruba-cx
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+2,492
−1,763
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…he default tags consistent
Contributor
Vale Linting ResultsSummary: 32 warnings, 4 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| packages/hpe_aruba_cx/_dev/build/docs/README.md | 13 | 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 | 54 | 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 | 73 | 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 | 81 | 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 | 83 | 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 | 93 | 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 | 101 | 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 | 116 | 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 | 169 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/hpe_aruba_cx/docs/README.md | 13 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/hpe_aruba_cx/docs/README.md | 54 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/hpe_aruba_cx/docs/README.md | 73 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/hpe_aruba_cx/docs/README.md | 81 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/hpe_aruba_cx/docs/README.md | 83 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/hpe_aruba_cx/docs/README.md | 93 | 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 | 101 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/hpe_aruba_cx/docs/README.md | 116 | 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 | 169 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/hpe_aruba_cx/docs/README.md | 223 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/hpe_aruba_cx/docs/README.md | 236 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/hpe_aruba_cx/docs/README.md | 258 | 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 | 278 | 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 | 156 | 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 | 156 | 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 | 1761 | Elastic.WordChoice | Consider using 'open' instead of 'Launch', unless the term is in the UI. |
| packages/hpe_aruba_cx/docs/README.md | 2528 | 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) |
💚 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]
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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