Skip to content

[Squid] update documentation ( LLM Generated )#17384

Open
qcorporation wants to merge 7 commits intomainfrom
465-squid-docs
Open

[Squid] update documentation ( LLM Generated )#17384
qcorporation wants to merge 7 commits intomainfrom
465-squid-docs

Conversation

@qcorporation
Copy link
Contributor

@qcorporation qcorporation commented Feb 11, 2026

Proposed commit message

This PR updates the Squid integration documentation with improved, AI-generated content that has been manually reviewed and verified against official Squid documentation.

What changed:

New documentation added:

  • Add docs/knowledge_base/service_info.md with setup instructions, troubleshooting, and vendor resources
  • Fix README vendor setup steps to match official Squid documentation
  • Fix Vale linting

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 (N/A - no dashboard changes)

Author's Checklist

  • Documentation verified against official Squid documentation
  • Vale linting issues resolved
  • Setup steps match official Syslog configuration guide
  • Licensing information verified (standard syslog is built-in feature)

Related issues

@qcorporation qcorporation self-assigned this Feb 11, 2026
@qcorporation qcorporation added Integration:squid Squid Proxy documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. labels Feb 11, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2026

Vale Linting Results

Summary: 4 warnings, 2 suggestions found

⚠️ Warnings (4)
File Line Rule Message
packages/squid/docs/README.md 209 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/squid/docs/README.md 222 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/squid/docs/README.md 244 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/squid/docs/README.md 264 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
💡 Suggestions (2)
File Line Rule Message
packages/squid/_dev/build/docs/README.md 27 Elastic.WordChoice Consider using 'select, press, visits' instead of 'hit', unless the term is in the UI.
packages/squid/docs/README.md 27 Elastic.WordChoice Consider using 'select, press, visits' instead of 'hit', 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.

@qcorporation qcorporation marked this pull request as ready for review February 11, 2026 23:01
@qcorporation qcorporation requested a review from a team as a code owner February 11, 2026 23:01
@elastic-vault-github-plugin-prod

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@andrewkroh andrewkroh added the Team:Integration-Experience Security Integrations Integration Experience [elastic/integration-experience] label Feb 12, 2026
@elasticmachine
Copy link

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

@mjwolf mjwolf added the enhancement New feature or request label Feb 12, 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.

This looks good to me, other than the one list to remove

@qcorporation qcorporation requested review from a team and mjwolf February 13, 2026 13:14
@elasticmachine
Copy link

💚 Build Succeeded

History

cc @qcorporation

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:squid Squid Proxy 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