Skip to content

Conversation

@PaulRMellor
Copy link
Contributor

@PaulRMellor PaulRMellor commented Dec 22, 2025

Documentation

A few minor doc edits from review

Checklist

Please go through this checklist and make sure all applicable tasks have been done

  • Write tests
  • Make sure all tests pass
  • Update documentation
  • Check RBAC rights for Kubernetes / OpenShift roles
  • Try your changes from Pod inside your Kubernetes and OpenShift cluster, not just locally
  • Reference relevant issue(s) and close them after merging
  • Update CHANGELOG.md
  • Supply screenshots for visual changes, such as Grafana dashboards

@PaulRMellor PaulRMellor added this to the 0.50.0 milestone Dec 22, 2025
@PaulRMellor PaulRMellor requested a review from a team December 22, 2025 17:36
@PaulRMellor PaulRMellor self-assigned this Dec 22, 2025
Copilot AI review requested due to automatic review settings December 22, 2025 17:36
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR contains minor documentation improvements addressing feedback from a review. The changes focus on improving clarity, grammar, consistency, and accuracy across OAuth configuration documentation, metrics documentation, and API reference documentation.

Key changes:

  • Enhanced clarity and grammar in OAuth authentication documentation
  • Corrected component naming for consistency (HTTP Bridge)
  • Fixed file path references in metrics documentation

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
documentation/modules/oauth/con-oauth-server-config.adoc Improved grammar and added security best practice note for bearer token handling
documentation/modules/oauth/con-oauth-client-config.adoc Refined wording from "structure" to "configuration pattern" for better clarity
documentation/modules/metrics/proc_metrics-custom-resource-monitoring.adoc Corrected grammar (singular "resource") and fixed file path from wildcard to specific filename
documentation/assemblies/oauth/assembly-oauth-security.adoc Updated "Kafka Bridge" to "HTTP Bridge" for consistency with project terminology
documentation/assemblies/metrics/assembly_metrics-prometheus-setup.adoc Fixed article usage ("an example" to "example") for correct grammar
documentation/api/io.strimzi.api.kafka.model.connect.KafkaConnectSpec.adoc Improved clarity and formatting of default value descriptions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov
Copy link

codecov bot commented Dec 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.81%. Comparing base (e15813d) to head (761a140).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main   #12272   +/-   ##
=========================================
  Coverage     74.81%   74.81%           
- Complexity     6627     6629    +2     
=========================================
  Files           376      376           
  Lines         25345    25345           
  Branches       3402     3402           
=========================================
  Hits          18962    18962           
- Misses         4995     4996    +1     
+ Partials       1388     1387    -1     

see 4 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@scholzj scholzj merged commit 3c7c1b0 into strimzi:main Dec 23, 2025
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants