-
Notifications
You must be signed in to change notification settings - Fork 540
[Squid] update documentation ( LLM Generated ) #17384
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
qcorporation
wants to merge
3
commits into
main
Choose a base branch
from
465-squid-docs
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.
Open
+662
−80
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
Contributor
Vale Linting ResultsSummary: 16 warnings, 2 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| packages/squid/_dev/build/docs/README.md | 103 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/_dev/build/docs/README.md | 114 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/_dev/build/docs/README.md | 126 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/docs/README.md | 103 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/docs/README.md | 114 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/docs/README.md | 126 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/docs/README.md | 215 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/docs/README.md | 228 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/docs/README.md | 250 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/squid/docs/README.md | 270 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/docs/knowledge_base/service_info.md | 75 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/docs/knowledge_base/service_info.md | 77 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/docs/knowledge_base/service_info.md | 87 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/docs/knowledge_base/service_info.md | 89 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/docs/knowledge_base/service_info.md | 100 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/squid/docs/knowledge_base/service_info.md | 102 | 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 | 33 | Elastic.WordChoice | Consider using 'select, press, visits' instead of 'hit', unless the term is in the UI. |
| packages/squid/docs/README.md | 33 | 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.
🚀 Benchmarks reportTo see the full report comment with |
💚 Build Succeeded
|
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.
Integration:squid
Squid Proxy
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 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:
docs/knowledge_base/service_info.mdwith setup instructions, troubleshooting, and vendor resourcesChecklist
changelog.ymlfile.Author's Checklist
Related issues