Skip to content

Make the 3.1 notes more prominent in kubernetes-events.md as this is a breaking change#1449

Open
douglasawh wants to merge 5 commits into
fluent:masterfrom
douglasawh:patch-1
Open

Make the 3.1 notes more prominent in kubernetes-events.md as this is a breaking change#1449
douglasawh wants to merge 5 commits into
fluent:masterfrom
douglasawh:patch-1

Conversation

@douglasawh
Copy link
Copy Markdown

@douglasawh douglasawh commented Aug 29, 2024

This is a pretty massive change in the way the plugin works. Sticking this at the bottom in a foot note does not seem appropriate.

The decision to do this initially does make some sense, as 3.1 is not going to be the version that everyone is using. However, over time, this will come to be the dominant behavior, and that behavior should be made clear to the users.

Summary by CodeRabbit

  • Documentation
    • Updated Kubernetes events configuration documentation with improved clarity
    • Refined configuration parameters table including updates to default values for namespace, TLS, and synchronization settings
    • Enhanced descriptions for better understanding of available configuration options

Review Change Stack

This is a pretty massive change in the way the plugin works. Sticking this at the bottom in a foot note does not seem appropriate.

The decision to do this initially does make some sense, as 3.1 is not going to be the version that everyone is using. However, over time, this will come to be the dominant behavior, and that behavior should be made clear to the users.

Signed-off-by: Doug Whitfield <dwhitfield@perforce.com>
@douglasawh douglasawh requested review from a team as code owners August 29, 2024 14:59
Copy link
Copy Markdown
Contributor

@lockewritesdocs lockewritesdocs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution @douglasawh! I suggested some editorial changes to incorporate.

Comment thread pipeline/inputs/kubernetes-events.md Outdated
This language much better than my original PR. All I *had* done is take what was in there, reformat it slightly, and move it to the top.

Co-authored-by: Adam Locke <adam.locke@chronosphere.io>
Signed-off-by: Doug Whitfield <douglasawh@gmail.com>
@lecaros
Copy link
Copy Markdown
Contributor

lecaros commented Aug 30, 2024

Hi @douglasawh,
thanks for your submission.
Could you please review our contributing guidelines and adhere to them? After that, we'll gladly merge your contribution.

Thanks

@lecaros lecaros added waiting-for-user Waiting for user/contributors feedback or requested changes dco DCO failing labels Aug 30, 2024
@douglasawh douglasawh changed the title Update kubernetes-events.md Make the 3.1 notes more prominent in kubernetes-events.md as this is a breaking change Aug 30, 2024
@github-actions
Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.

@github-actions github-actions Bot added the Stale label Nov 29, 2024
@github-actions github-actions Bot removed the Stale label Mar 26, 2025
@github-actions
Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.

@github-actions github-actions Bot added the Stale label Jun 24, 2025
@github-actions github-actions Bot removed the Stale label Oct 1, 2025
@eschabell eschabell self-assigned this Oct 21, 2025
@eschabell eschabell added conflict Waiting on conflict to be resolved by contributor and removed dco DCO failing labels Oct 21, 2025
@eschabell
Copy link
Copy Markdown
Collaborator

@douglasawh can you please fix the conflicts here so I can merge for you?

Signed-off-by: Lynette  Miles <6818907+esmerel@users.noreply.github.com>
@esmerel esmerel removed conflict Waiting on conflict to be resolved by contributor waiting-for-user Waiting for user/contributors feedback or requested changes labels Oct 21, 2025
@esmerel
Copy link
Copy Markdown
Contributor

esmerel commented Oct 21, 2025

The conflicts were due to formatting changes for style, I went ahead and fixed the conflicts in the interest of keeping things moving.

Comment thread pipeline/inputs/kubernetes-events.md Outdated
Signed-off-by: Lynette  Miles <6818907+esmerel@users.noreply.github.com>
@patrick-stephens
Copy link
Copy Markdown
Contributor

The DCO failure is a hard block

@eschabell eschabell added dco DCO failing waiting-on-review Waiting on a review from mainteners labels Oct 24, 2025
@esmerel esmerel removed the waiting-on-review Waiting on a review from mainteners label Oct 28, 2025
@eschabell
Copy link
Copy Markdown
Collaborator

@douglasawh if you can look at the DCO failures, we've pushed through the original conflicts for you, would love to have this PR in a clean state to merge?

@eschabell eschabell added the waiting-for-user Waiting for user/contributors feedback or requested changes label Nov 4, 2025
Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-requested a review as a code owner May 27, 2026 15:11
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b4115b6a-1fdd-4602-8e87-2049555a22cb

📥 Commits

Reviewing files that changed from the base of the PR and between 5231934 and f8c4481.

📒 Files selected for processing (1)
  • pipeline/inputs/kubernetes-events.md

📝 Walkthrough

Walkthrough

The PR updates the Kubernetes Events input plugin configuration documentation by renaming the section header and revising the configuration parameters table. Key defaults are clarified, including kube_namespace now defaulting to all and tls.verify displayed as On instead of true, with minor wording adjustments across multiple parameter descriptions.

Changes

Kubernetes Events Configuration Documentation

Layer / File(s) Summary
Kubernetes Events configuration table and section header
pipeline/inputs/kubernetes-events.md
The "Configuration parameters" section header is renamed to "Configuration" and the configuration table is revised with updated defaults and descriptions for kube_namespace (now defaults to all), tls.verify (displayed as On instead of true), tls.debug wording adjustment, and minor formatting changes to other parameter descriptions and defaults.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • fluent/fluent-bit-docs#2273: Also updates pipeline/inputs/kubernetes-events.md with configuration table reformatting and adjustments to the same parameter defaults including kube_namespace and tls.verify.

Suggested labels

4.2.1

Poem

🐰 A doc hop through the config zone,
Where defaults now are clearly shown!
From true to On, from params to pure,
Kubernetes events, crystal sure. ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The PR title claims to make 3.1 notes more prominent in kubernetes-events.md, but the summary shows only configuration table reformatting with no evidence of moving or promoting version notes. Update the title to accurately reflect the actual changes made (e.g., 'Update kubernetes-events configuration documentation formatting') or verify the actual intended changes match the title.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@eschabell
Copy link
Copy Markdown
Collaborator

@douglasawh you need to fix this yourself and we can merge this change:

"Commit sha: 62bfca7, Author: Doug Whitfield, Committer: GitHub; Expected "Doug Whitfield dwhitfield@perforce.com", but got "Doug Whitfield douglasawh@gmail.com"."

@eschabell eschabell added the waiting-on-review Waiting on a review from mainteners label May 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dco DCO failing waiting-for-user Waiting for user/contributors feedback or requested changes waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants