[fortinet_fortiedr] Update documentation#17399
Open
taylor-swanson wants to merge 7 commits intoelastic:mainfrom
Open
[fortinet_fortiedr] Update documentation#17399taylor-swanson wants to merge 7 commits intoelastic:mainfrom
taylor-swanson wants to merge 7 commits intoelastic:mainfrom
Conversation
- Update documentation - Fix typo in manifest file
taylor-swanson
added
documentation
Contributor
Vale Linting ResultsSummary: 17 warnings, 14 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| packages/fortinet_fortiedr/docs/README.md | 232 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/fortinet_fortiedr/docs/README.md | 247 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/fortinet_fortiedr/docs/README.md | 269 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/fortinet_fortiedr/docs/README.md | 289 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/fortinet_fortiedr/docs/README.md | 338 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/fortinet_fortiedr/docs/README.md | 338 | Elastic.DontUse | Don't use 'please'. |
| packages/fortinet_fortiedr/docs/README.md | 339 | Elastic.DontUse | Don't use 'Note that'. |
| packages/fortinet_fortiedr/docs/README.md | 339 | Elastic.DontUse | Don't use 'note that'. |
| packages/fortinet_fortiedr/docs/README.md | 339 | Elastic.DontUse | Don't use 'note that'. |
| packages/fortinet_fortiedr/docs/README.md | 340 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/fortinet_fortiedr/docs/README.md | 340 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/fortinet_fortiedr/docs/README.md | 340 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/fortinet_fortiedr/docs/README.md | 340 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/fortinet_fortiedr/docs/README.md | 393 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/fortinet_fortiedr/docs/README.md | 393 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/fortinet_fortiedr/docs/knowledge_base/service_info.md | 82 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/fortinet_fortiedr/docs/knowledge_base/service_info.md | 157 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
💡 Suggestions (14)
| File | Line | Rule | Message |
|---|---|---|---|
| packages/fortinet_fortiedr/_dev/build/docs/README.md | 3 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/fortinet_fortiedr/_dev/build/docs/README.md | 20 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| packages/fortinet_fortiedr/docs/README.md | 3 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/fortinet_fortiedr/docs/README.md | 20 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| packages/fortinet_fortiedr/docs/README.md | 331 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/fortinet_fortiedr/docs/README.md | 338 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/fortinet_fortiedr/docs/README.md | 338 | Elastic.WordChoice | Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI. |
| packages/fortinet_fortiedr/docs/README.md | 339 | Elastic.WordChoice | Consider using 'efficiently' instead of 'simply', unless the term is in the UI. |
| packages/fortinet_fortiedr/docs/README.md | 339 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/fortinet_fortiedr/docs/README.md | 389 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/fortinet_fortiedr/docs/README.md | 404 | Elastic.Wordiness | Consider using 'all' instead of 'All of '. |
| packages/fortinet_fortiedr/docs/knowledge_base/service_info.md | 95 | Elastic.HeadingColons | Capitalize ': l'. |
| packages/fortinet_fortiedr/docs/knowledge_base/service_info.md | 108 | Elastic.HeadingColons | Capitalize ': t'. |
| packages/fortinet_fortiedr/docs/knowledge_base/service_info.md | 124 | Elastic.HeadingColons | Capitalize ': u'. |
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 |
|
Pinging @elastic/integration-experience (Team:Integration-Experience) |
mjwolf
reviewed
Feb 12, 2026
Contributor
mjwolf
left a comment
mjwolf
left a comment
There was a problem hiding this comment.
Thanks for working on this. It looks good to me, there are just some small changes needed. There's also some suggested linter changes (you don't need to make changes on the ECS fields or other generated text)
Comment on lines
7
to
12
| This integration facilitates: | ||
| - Endpoint threat monitoring: You'll monitor real-time security events detected by FortiEDR to identify and respond to malware, ransomware, and unauthorized access attempts across your fleet. | ||
| - Audit and compliance: You'll maintain a comprehensive audit trail of administrative actions and user activities within the FortiEDR console to satisfy regulatory compliance requirements. | ||
| - Incident investigation: You'll leverage detailed process and network telemetry from FortiEDR logs to perform root cause analysis and reconstruct the timeline of security incidents. | ||
| - Operational health oversight: You'll track system-level events and operational status changes within the FortiEDR environment to ensure your security infrastructure is functioning optimally. | ||
|
|
Contributor
There was a problem hiding this comment.
Suggested change
| This integration facilitates: | |
| - Endpoint threat monitoring: You'll monitor real-time security events detected by FortiEDR to identify and respond to malware, ransomware, and unauthorized access attempts across your fleet. | |
| - Audit and compliance: You'll maintain a comprehensive audit trail of administrative actions and user activities within the FortiEDR console to satisfy regulatory compliance requirements. | |
| - Incident investigation: You'll leverage detailed process and network telemetry from FortiEDR logs to perform root cause analysis and reconstruct the timeline of security incidents. | |
| - Operational health oversight: You'll track system-level events and operational status changes within the FortiEDR environment to ensure your security infrastructure is functioning optimally. |
This list can be removed, it's duplicated in the Supported use case section
| - Message truncation: | ||
| For large security events sent using UDP, logs might be truncated. Increase the `max_message_size` and `read_buffer` in the **Custom UDP Options** if you notice incomplete payloads. | ||
|
|
||
| For vendor documentation links, see the [Vendor documentation links](#vendor-documentation-links) section. |
Contributor
There was a problem hiding this comment.
I think this anchor link won't work in the published pages. It's ok to remove it completely
| - [FortiEDR Administration Guide: Automated Incident Response - Playbooks](https://docs.fortinet.com/document/fortiedr/7.2.0/administration-guide/419440/automated-incident-response-playbooks-page) | ||
| - [Fortinet FortiEDR Administration Guide](https://docs.fortinet.com/document/fortiedr/7.2.0/administration-guide) | ||
| - [Fortinet Documentation Library](https://docs.fortinet.com/) | ||
| - [Elastic Fortinet FortiEDR Integration Reference](https://www.elastic.co/docs/reference/integrations/fortinet_fortiedr) |
Contributor
There was a problem hiding this comment.
Suggested change
| - [Elastic Fortinet FortiEDR Integration Reference](https://www.elastic.co/docs/reference/integrations/fortinet_fortiedr) |
This can be removed, it will just link to itself
|
|
||
| Choose the setup instructions below that match your configuration: | ||
|
|
||
| #### Log file input configuration |
Contributor
There was a problem hiding this comment.
I think log input is the least used input type, so I think it makes more sense to put this below the TCP/UDP sections
mjwolf
approved these changes
Feb 13, 2026
💚 Build Succeeded
History
|
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
3 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.
Proposed commit message
Assisted by Google Gemini and Claude Opus.
Checklist
changelog.ymlfile.- [ ] I have verified that any added dashboard complies with Kibana's Dashboard good practicesRelated issues