Skip to content

[DOCS] Part 3 - Remove duplicated installation instructions - #14376

Merged
alaudazzi merged 25 commits into
mainfrom
fix-800
Jul 2, 2025
Merged

[DOCS] Part 3 - Remove duplicated installation instructions#14376
alaudazzi merged 25 commits into
mainfrom
fix-800

Conversation

@alaudazzi

@alaudazzi alaudazzi commented Jul 1, 2025

Copy link
Copy Markdown
Contributor

This PR:

  • Removes the Install sections as these are the same [installation instructions] linked from the Requirements section.
  • Updates the link format, compatible with the new doc system rules
  • Adjusts the text in the Requirements section

This PR fixes the following packages:

  • /packages/armis
  • /citrix_adc
  • /claroty_xdome
  • /imperva
  • /microsoft_dnsserver
  • /squid
  • /watchguard_firebox

Relates to:

@alaudazzi alaudazzi self-assigned this Jul 1, 2025
@alaudazzi
alaudazzi requested review from a team as code owners July 1, 2025 05:34
@alaudazzi alaudazzi added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:citrix_adc Citrix ADC Integration:armis Armis labels Jul 1, 2025
@alaudazzi alaudazzi added the Integration:claroty_xdome Claroty xDome label Jul 1, 2025
@alaudazzi
alaudazzi requested a review from a team as a code owner July 1, 2025 05:52
@alaudazzi alaudazzi added the Integration:microsoft_dnsserver Microsoft DNS Server label Jul 1, 2025
@alaudazzi alaudazzi added the Integration:squid Squid Proxy label Jul 1, 2025
@elastic-vault-github-plugin-prod

elastic-vault-github-plugin-prod Bot commented Jul 1, 2025

Copy link
Copy Markdown
Contributor

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@alaudazzi alaudazzi added the Integration:watchguard_firebox WatchGuard Firebox label Jul 1, 2025
@shmsr
shmsr requested a review from Copilot July 1, 2025 09:55

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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).
Comment thread packages/citrix_adc/_dev/build/docs/README.md Outdated
Comment thread packages/claroty_xdome/_dev/build/docs/README.md Outdated
Comment thread packages/imperva/_dev/build/docs/README.md Outdated
Comment thread packages/imperva/docs/README.md Outdated
Comment thread packages/squid/_dev/build/docs/README.md Outdated
alaudazzi and others added 3 commits July 1, 2025 12:08
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>
@elasticmachine

Copy link
Copy Markdown

Pinging @elastic/sec-windows-platform (Team:Security-Windows Platform)

@elasticmachine

Copy link
Copy Markdown

Pinging @elastic/security-service-integrations (Team:Security-Service Integrations)

@elasticmachine

Copy link
Copy Markdown

Pinging @elastic/sec-deployment-and-devices (Team:Security-Deployment and Devices)

@kcreddy kcreddy left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Reviewed armis, claroty_xdome.

Comment thread packages/armis/_dev/build/docs/README.md Outdated
Comment thread packages/armis/_dev/build/docs/README.md Outdated
Comment thread packages/armis/changelog.yml Outdated
Comment thread packages/claroty_xdome/_dev/build/docs/README.md Outdated
alaudazzi and others added 11 commits July 1, 2025 16:23
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>
@elasticmachine

Copy link
Copy Markdown

💚 Build Succeeded

History

cc @alaudazzi

@kcreddy kcreddy left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM for armis, claroty_xdome.

@alaudazzi
alaudazzi merged commit ecdd229 into main Jul 2, 2025
@alaudazzi
alaudazzi deleted the fix-800 branch July 2, 2025 14:36
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

Package armis - 0.2.0 containing this change is available at https://epr.elastic.co/package/armis/0.2.0/

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

Package citrix_adc - 1.17.0 containing this change is available at https://epr.elastic.co/package/citrix_adc/1.17.0/

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

Package claroty_xdome - 0.2.0 containing this change is available at https://epr.elastic.co/package/claroty_xdome/0.2.0/

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

Package imperva - 1.7.0 containing this change is available at https://epr.elastic.co/package/imperva/1.7.0/

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

Package microsoft_dnsserver - 1.3.0 containing this change is available at https://epr.elastic.co/package/microsoft_dnsserver/1.3.0/

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

Package squid - 1.3.0 containing this change is available at https://epr.elastic.co/package/squid/1.3.0/

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

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

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:armis Armis Integration:citrix_adc Citrix ADC Integration:claroty_xdome Claroty xDome Integration:imperva Imperva Integration:microsoft_dnsserver Microsoft DNS Server Integration:squid Squid Proxy Integration:watchguard_firebox WatchGuard Firebox Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] Team:Security-Deployment and Devices DEPRECATED Deployment and Devices Security team [elastic/sec-deployment-and-devices] Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations] Team:Security-Windows Platform Security Windows Platform team [elastic/sec-windows-platform]

8 participants