[DOCS] Part 3 - Remove duplicated installation instructions #14376
+198
−437
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
alaudazzi
added
documentation
🚀 Benchmarks reportTo see the full report comment with |
There was a problem hiding this comment.
Pull Request Overview
This PR removes redundant installation instructions across multiple integration docs, updates link formats to the new doc system, and adjusts the Requirements and Compatibility sections accordingly.
- Consolidated install steps into a single Requirements section with new
docs-content://links - Bumped version numbers in all package manifests
- Added changelog entries for each new version
Reviewed Changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/watchguard_firebox/manifest.yml | Bump version to 1.4.0 |
| packages/watchguard_firebox/docs/README.md | Remove duplicated install instructions; update Requirements/Compatibility |
| packages/watchguard_firebox/changelog.yml | Add changelog entry for 1.4.0 |
| packages/watchguard_firebox/_dev/build/docs/README.md | Sync docs changes |
| packages/squid/manifest.yml | Bump version to 1.3.0 |
| packages/squid/docs/README.md | Remove duplicated install instructions; update Requirements |
| packages/squid/changelog.yml | Add changelog entry for 1.3.0 |
| packages/squid/_dev/build/docs/README.md | Sync docs changes |
| packages/microsoft_dnsserver/manifest.yml | Bump version to 1.3.0 |
| packages/microsoft_dnsserver/docs/README.md | Remove duplicated install instructions; update Requirements |
| packages/microsoft_dnsserver/changelog.yml | Add changelog entry for 1.3.0 |
| packages/microsoft_dnsserver/_dev/build/docs/README.md | Sync docs changes |
| packages/imperva/manifest.yml | Bump version to 1.7.0 |
| packages/imperva/docs/README.md | Remove duplicated install instructions; update Requirements |
| packages/imperva/changelog.yml | Add changelog entry for 1.7.0 |
| packages/imperva/_dev/build/docs/README.md | Sync docs changes |
| packages/claroty_xdome/manifest.yml | Bump version to 0.2.0 |
| packages/claroty_xdome/docs/README.md | Remove duplicated install instructions; update Requirements |
| packages/claroty_xdome/changelog.yml | Add changelog entry for 0.2.0 |
| packages/claroty_xdome/_dev/build/docs/README.md | Sync docs changes |
| packages/citrix_adc/manifest.yml | Bump version to 1.17.0 |
| packages/citrix_adc/docs/README.md | Remove duplicated install instructions; update Requirements/Compatibility |
| packages/citrix_adc/changelog.yml | Add changelog entry for 1.17.0 |
| packages/citrix_adc/_dev/build/docs/README.md | Sync docs changes |
| packages/armis/manifest.yml | Bump version to 0.2.0 |
| packages/armis/docs/README.md | Remove duplicated install instructions; update Requirements |
| packages/armis/changelog.yml | Add changelog entry for 0.2.0 |
| packages/armis/_dev/build/docs/README.md | Sync docs changes |
Comments suppressed due to low confidence (8)
packages/squid/docs/README.md:26
- This list item is missing a bullet marker; prefix it with '- ' to render it as a proper list entry.
[Native log file](https://wiki.squid-cache.org/Features/LogFormat#squid)
packages/squid/_dev/build/docs/README.md:26
- This list item is missing a bullet marker; prefix it with '- ' to render it as a proper list entry.
[Native log file](https://wiki.squid-cache.org/Features/LogFormat#squid)
packages/citrix_adc/docs/README.md:47
- The sentence is broken across two lines; consider merging it into one line, e.g., 'check the quick start guide' for proper rendering.
[quick start](integrations://docs/extend/quick-start.md)
packages/citrix_adc/_dev/build/docs/README.md:47
- The sentence is broken across two lines; consider merging it into one line, e.g., 'check the quick start guide' for proper rendering.
[quick start](integrations://docs/extend/quick-start.md)
packages/claroty_xdome/docs/README.md:19
- [nitpick] Inconsistent styling—other integrations use 'NOTE:'; consider switching to 'NOTE:' for uniformity.
**NOTES:**
packages/claroty_xdome/_dev/build/docs/README.md:19
- [nitpick] Inconsistent styling—other integrations use 'NOTE:'; consider switching to 'NOTE:' for uniformity.
**NOTES:**
packages/imperva/docs/README.md:53
- There is an extra space before the URL in the link syntax; remove the space after '(' to fix the link.
For more information on working with action sets and followed actions, check the Imperva [documentation]( https://docs.imperva.com/bundle/v15.0-waf-management-server-manager-user-guide/page/Working_with_Action_Sets_and_Followed_Actions.htm).
packages/imperva/_dev/build/docs/README.md:53
- There is an extra space before the URL in the link syntax; remove the space after '(' to fix the link.
For more information on working with action sets and followed actions, check the Imperva [documentation]( https://docs.imperva.com/bundle/v15.0-waf-management-server-manager-user-guide/page/Working_with_Action_Sets_and_Followed_Actions.htm).
shmsr
requested changes
Jul 1, 2025
Co-authored-by: subham sarkar <subham.sarkar@elastic.co>
Co-authored-by: subham sarkar <subham.sarkar@elastic.co>
Co-authored-by: subham sarkar <subham.sarkar@elastic.co>
shmsr
approved these changes
Jul 1, 2025
|
Pinging @elastic/sec-windows-platform (Team:Security-Windows Platform) |
|
Pinging @elastic/security-service-integrations (Team:Security-Service Integrations) |
|
Pinging @elastic/sec-deployment-and-devices (Team:Security-Deployment and Devices) |
kcreddy
reviewed
Jul 1, 2025
Co-authored-by: Krishna Chaitanya Reddy Burri <krishnachaitanyareddy.burri@elastic.co>
Co-authored-by: Krishna Chaitanya Reddy Burri <krishnachaitanyareddy.burri@elastic.co>
Co-authored-by: Krishna Chaitanya Reddy Burri <krishnachaitanyareddy.burri@elastic.co>
|
💚 Build Succeeded
History
cc @alaudazzi |
kcreddy
approved these changes
Jul 2, 2025
marc-gr
approved these changes
Jul 2, 2025
jrmolin
approved these changes
Jul 2, 2025
|
Package armis - 0.2.0 containing this change is available at https://epr.elastic.co/package/armis/0.2.0/ |
|
Package citrix_adc - 1.17.0 containing this change is available at https://epr.elastic.co/package/citrix_adc/1.17.0/ |
|
Package claroty_xdome - 0.2.0 containing this change is available at https://epr.elastic.co/package/claroty_xdome/0.2.0/ |
|
Package imperva - 1.7.0 containing this change is available at https://epr.elastic.co/package/imperva/1.7.0/ |
|
Package microsoft_dnsserver - 1.3.0 containing this change is available at https://epr.elastic.co/package/microsoft_dnsserver/1.3.0/ |
|
Package squid - 1.3.0 containing this change is available at https://epr.elastic.co/package/squid/1.3.0/ |
|
Package watchguard_firebox - 1.4.0 containing this change is available at https://epr.elastic.co/package/watchguard_firebox/1.4.0/ |
robester0403
pushed a commit
to robester0403/integrations
that referenced
this pull request
Jul 8, 2025
…14376) * Update citrix-adc * Update armis * Update claroty_xdome * imperva * Update microsoft_dnsserver * Update squid * Update watchguard_firebox * Update changelog and manifest files * Update packages/claroty_xdome/_dev/build/docs/README.md Co-authored-by: subham sarkar <subham.sarkar@elastic.co> * Update packages/imperva/_dev/build/docs/README.md Co-authored-by: subham sarkar <subham.sarkar@elastic.co> * Update packages/imperva/docs/README.md Co-authored-by: subham sarkar <subham.sarkar@elastic.co> * Integrate reviewer's comment * Integrate interviewer's comment * Update packages/armis/_dev/build/docs/README.md Co-authored-by: Krishna Chaitanya Reddy Burri <krishnachaitanyareddy.burri@elastic.co> * Update packages/armis/changelog.yml Co-authored-by: Krishna Chaitanya Reddy Burri <krishnachaitanyareddy.burri@elastic.co> * Update packages/claroty_xdome/_dev/build/docs/README.md Co-authored-by: Krishna Chaitanya Reddy Burri <krishnachaitanyareddy.burri@elastic.co> * Integrate kcreddy comments * Update changelog.yml * Update changelog.yml * Update changelog.yml * Update changelog.yml * Update changelog.yml * Update changelog.yml * Update claroty_xdome --------- Co-authored-by: subham sarkar <subham.sarkar@elastic.co> Co-authored-by: Krishna Chaitanya Reddy Burri <krishnachaitanyareddy.burri@elastic.co>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR:
This PR fixes the following packages:
Relates to: