Open
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
Vale Linting ResultsSummary: 9 warnings, 5 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| packages/modsecurity/_dev/build/docs/README.md | 75 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
| packages/modsecurity/_dev/build/docs/README.md | 75 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
| packages/modsecurity/_dev/build/docs/README.md | 97 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
| packages/modsecurity/docs/README.md | 75 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
| packages/modsecurity/docs/README.md | 75 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
| packages/modsecurity/docs/README.md | 97 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
| packages/modsecurity/docs/README.md | 194 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/modsecurity/docs/knowledge_base/service_info.md | 65 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
| packages/modsecurity/docs/knowledge_base/service_info.md | 87 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
💡 Suggestions (5)
| File | Line | Rule | Message |
|---|---|---|---|
| packages/modsecurity/_dev/build/docs/README.md | 3 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/modsecurity/_dev/build/docs/README.md | 97 | Elastic.Semicolons | Use semicolons judiciously. |
| packages/modsecurity/docs/README.md | 3 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/modsecurity/docs/README.md | 97 | Elastic.Semicolons | Use semicolons judiciously. |
| packages/modsecurity/docs/knowledge_base/service_info.md | 87 | Elastic.Semicolons | Use semicolons judiciously. |
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.
ilyannn
added
documentation
Replace Latin term "via" with "using"/"through" and "see" with "get" per Elastic docs style guide. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add ModSecurity v2 for Apache (v2.9.x) to compatibility section - Soften Part K exclusion from "must"/"CRITICAL" to recommendation - Clarify event.original requires preserve_original_event enabled - Fix inconsistent SecAuditLogParts in troubleshooting section Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Reflects factual corrections in service_info.md: - Compatibility section now notes v2 Apache test coverage - Part K exclusion softened to recommendation - Validation step clarifies event.original requires opt-in - Consistent SecAuditLogParts across setup and troubleshooting Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove two Gemini-generated AI disclaimers not present in other integration docs. Replace "via" with "using" per Elastic style guide. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Align troubleshooting recommendation with setup section. Part H (audit trailer) contains useful action and timing data. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove link to this same integration doc page and generic Elastic Agent Troubleshooting link from vendor documentation sections. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
🚀 Benchmarks reportPackage
|
| Data stream | Previous EPS | New EPS | Diff (%) | Result |
|---|---|---|---|---|
auditlog |
1203.37 | 834.03 | -369.34 (-30.69%) | 💔 |
To see the full report comment with /test benchmark fullreport
… vendor sections The Apache support was added in PR elastic#3363 for ModSecurity v2 (2.9.x), not v3 with the Apache connector. Updated compatibility to reflect what is actually tested. Removed duplicate vendor resource sections and circular self-referencing links. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Pinging @elastic/integration-experience (Team:Integration-Experience) |
💚 Build Succeeded
History
cc @ilyannn |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
service_info.mdknowledge base with reviewed, fact-checked integration detailselastic-package update documentationto follow the new template structuredocs_structure_enforcedvalidationBreaking Changes in Docs
Compared to the previous docs, we:
modsec-audit.jsonfile name in examples rather thanmodsec_audit.jsonSecAuditLogType Serialas criticalABFHJZparts as an example (wasABDEFHIJZpreviously)Kibana rendering
Note the code in numbered list looks like this but this apparently how our rendering works (perhaps we should reduce the indent of code in the lists in this case?). GitHub does not like this formatting either.
Test plan
elastic-package checkpasses (tested with both system and dev builds)service_info.mdground truthCloses https://github.com/elastic/integration-experience/issues/456
🤖 These documentation changes have been largely GenAI-generated as per our protocol. Additionally, Claude Code was used for factual review and as a harness for editing/commit/PR generation under our editorial supervision.