Skip to content

[cloudflare_logpush] Update README documentation as per new guidelines#18498

Draft
brijesh-elastic wants to merge 4 commits intoelastic:mainfrom
brijesh-elastic:cloudflare_logpush-readme
Draft

[cloudflare_logpush] Update README documentation as per new guidelines#18498
brijesh-elastic wants to merge 4 commits intoelastic:mainfrom
brijesh-elastic:cloudflare_logpush-readme

Conversation

@brijesh-elastic
Copy link
Copy Markdown
Collaborator

@brijesh-elastic brijesh-elastic commented Apr 17, 2026 •
edited
Loading

Proposed commit message

cloudflare_logpush: update README documentation as per new guideline

This PR also updates manifest titles and descriptions to be consistent with other integrations.

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

Related issues

@brijesh-elastic brijesh-elastic self-assigned this Apr 17, 2026
@brijesh-elastic brijesh-elastic added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:cloudflare_logpush Cloudflare Logpush Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations] Team:SDE-Crest Crest developers on the Security Integrations team [elastic/sit-crest-contractors] labels Apr 17, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 20, 2026 •
edited
Loading

Vale Linting Results

Summary: 26 warnings, 10 suggestions found

⚠️ Warnings (26)
File Line Rule Message
packages/cloudflare_logpush/_dev/build/docs/README.md 55 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'.
packages/cloudflare_logpush/_dev/build/docs/README.md 149 Elastic.DontUse Don't use 'please'.
packages/cloudflare_logpush/_dev/build/docs/README.md 153 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/cloudflare_logpush/_dev/build/docs/README.md 160 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/_dev/build/docs/README.md 172 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/_dev/build/docs/README.md 181 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/_dev/build/docs/README.md 192 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/_dev/build/docs/README.md 193 Elastic.DontUse Don't use 'Please'.
packages/cloudflare_logpush/_dev/build/docs/README.md 194 Elastic.DontUse Don't use 'please'.
packages/cloudflare_logpush/_dev/build/docs/README.md 235 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/_dev/build/docs/README.md 238 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/_dev/build/docs/README.md 239 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/_dev/build/docs/README.md 265 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/docs/README.md 55 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'.
packages/cloudflare_logpush/docs/README.md 149 Elastic.DontUse Don't use 'please'.
packages/cloudflare_logpush/docs/README.md 153 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
packages/cloudflare_logpush/docs/README.md 160 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/docs/README.md 172 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/docs/README.md 181 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/docs/README.md 192 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/docs/README.md 193 Elastic.DontUse Don't use 'Please'.
packages/cloudflare_logpush/docs/README.md 194 Elastic.DontUse Don't use 'please'.
packages/cloudflare_logpush/docs/README.md 235 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/docs/README.md 238 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/docs/README.md 239 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
packages/cloudflare_logpush/docs/README.md 265 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
💡 Suggestions (10)
File Line Rule Message
packages/cloudflare_logpush/_dev/build/docs/README.md 7 Elastic.Semicolons Use semicolons judiciously.
packages/cloudflare_logpush/_dev/build/docs/README.md 7 Elastic.Semicolons Use semicolons judiciously.
packages/cloudflare_logpush/_dev/build/docs/README.md 7 Elastic.Semicolons Use semicolons judiciously.
packages/cloudflare_logpush/_dev/build/docs/README.md 225 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/cloudflare_logpush/_dev/build/docs/README.md 242 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
packages/cloudflare_logpush/docs/README.md 7 Elastic.Semicolons Use semicolons judiciously.
packages/cloudflare_logpush/docs/README.md 7 Elastic.Semicolons Use semicolons judiciously.
packages/cloudflare_logpush/docs/README.md 7 Elastic.Semicolons Use semicolons judiciously.
packages/cloudflare_logpush/docs/README.md 225 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/cloudflare_logpush/docs/README.md 242 Elastic.WordChoice Consider using 'can, might' instead of 'may', 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.

@brijesh-elastic brijesh-elastic marked this pull request as ready for review April 20, 2026 05:25
@brijesh-elastic brijesh-elastic requested a review from a team as a code owner April 20, 2026 05:25
@elasticmachine
Copy link
Copy Markdown

elasticmachine commented Apr 20, 2026

Pinging @elastic/security-service-integrations (Team:Security-Service Integrations)

@elastic-vault-github-plugin-prod
Copy link
Copy Markdown

elastic-vault-github-plugin-prod Bot commented Apr 20, 2026

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@elasticmachine
Copy link
Copy Markdown

elasticmachine commented Apr 20, 2026

💚 Build Succeeded

History

cc @brijesh-elastic

@brijesh-elastic brijesh-elastic marked this pull request as draft April 29, 2026 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@brijesh-elastic brijesh-elastic

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:cloudflare_logpush Cloudflare Logpush Team:SDE-Crest Crest developers on the Security Integrations team [elastic/sit-crest-contractors] Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations]

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

cloudflare_logpush: Update documentation

2 participants

@brijesh-elastic @elasticmachine