Skip to content

[cef] documentation update#17258

Open
jrmolin wants to merge 23 commits intoelastic:mainfrom
jrmolin:cef-update_documentation
Open

[cef] documentation update#17258
jrmolin wants to merge 23 commits intoelastic:mainfrom
jrmolin:cef-update_documentation

Conversation

@jrmolin
Copy link
Contributor

@jrmolin jrmolin commented Feb 5, 2026

Proposed commit message

[cef] Documentation Update

  • run the LLM documentation updater
  • fix all the vale suggestions

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

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Screenshots

@jrmolin jrmolin added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:cef Common Event Format (CEF) labels Feb 5, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Vale Linting Results

Summary: 10 warnings, 9 suggestions found

⚠️ Warnings (10)
File Line Rule Message
packages/cef/docs/README.md 267 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cef/docs/README.md 282 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cef/docs/README.md 304 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/cef/docs/README.md 324 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cef/docs/knowledge_base/service_info.md 51 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/cef/docs/knowledge_base/service_info.md 54 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/cef/docs/knowledge_base/service_info.md 55 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/cef/docs/knowledge_base/service_info.md 133 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'.
packages/cef/docs/knowledge_base/service_info.md 133 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'.
packages/cef/docs/knowledge_base/service_info.md 155 Elastic.DontUse Don't use 'and/or'.
💡 Suggestions (9)
File Line Rule Message
packages/cef/_dev/build/docs/README.md 21 Elastic.Versions Use 'or later' instead of 'or higher' when referring to versions.
packages/cef/_dev/build/docs/README.md 47 Elastic.FirstPerson Avoid first-person pronouns such as ' I '.
packages/cef/_dev/build/docs/README.md 60 Elastic.FirstPerson Avoid first-person pronouns such as ' I '.
packages/cef/docs/README.md 21 Elastic.Versions Use 'or later' instead of 'or higher' when referring to versions.
packages/cef/docs/README.md 47 Elastic.FirstPerson Avoid first-person pronouns such as ' I '.
packages/cef/docs/README.md 60 Elastic.FirstPerson Avoid first-person pronouns such as ' I '.
packages/cef/docs/knowledge_base/service_info.md 93 Elastic.HeadingColons Capitalize ': l'.
packages/cef/docs/knowledge_base/service_info.md 107 Elastic.HeadingColons Capitalize ': u'.
packages/cef/docs/knowledge_base/service_info.md 123 Elastic.HeadingColons Capitalize ': t'.

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.

@elastic-vault-github-plugin-prod

🚀 Benchmarks report

Package cef 👍(0) 💚(0) 💔(1)

Expand to view
Data stream Previous EPS New EPS Diff (%) Result
log 4098.36 3184.71 -913.65 (-22.29%) 💔

To see the full report comment with /test benchmark fullreport

@elasticmachine
Copy link

💚 Build Succeeded

@jrmolin jrmolin marked this pull request as ready for review February 5, 2026 18:01
@jrmolin jrmolin requested a review from a team as a code owner February 5, 2026 18:01
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:cef Common Event Format (CEF)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants