Skip to content

docs(glossary): adds new glossary of strimzi terms#11962

Merged
PaulRMellor merged 4 commits intostrimzi:mainfrom
PaulRMellor:docs_glossary-of-terms
Oct 8, 2025
Merged

docs(glossary): adds new glossary of strimzi terms#11962
PaulRMellor merged 4 commits intostrimzi:mainfrom
PaulRMellor:docs_glossary-of-terms

Conversation

@PaulRMellor
Copy link
Copy Markdown
Contributor

@PaulRMellor PaulRMellor commented Oct 1, 2025

Documentation

New glossary for Strimzi-specific terms, features, components etc.
Doesn't include deprecated items like opa, oauth, keycloak or Kraft-mode references

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

Signed-off-by: prmellor <pmellor@redhat.com>
@PaulRMellor PaulRMellor added this to the 0.49.0 milestone Oct 1, 2025
@PaulRMellor PaulRMellor requested a review from a team October 1, 2025 14:42
@PaulRMellor PaulRMellor self-assigned this Oct 1, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 1, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.78%. Comparing base (334ec5a) to head (6ae91f9).
⚠️ Report is 25 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main   #11962      +/-   ##
============================================
+ Coverage     74.63%   74.78%   +0.14%     
- Complexity     6399     6409      +10     
============================================
  Files           342      342              
  Lines         24238    24207      -31     
  Branches       3194     3185       -9     
============================================
+ Hits          18091    18104      +13     
+ Misses         4876     4834      -42     
+ Partials       1271     1269       -2     

see 11 files with indirect coverage changes

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

Copy link
Copy Markdown
Member

@scholzj scholzj left a comment

Choose a reason for hiding this comment

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

I left some nits. I think it looks good, just not entirely sure about the purpose. Without some links for more details, it does not seem so useful. (Just to be clear - I do not have an issue with this getting merged. Just a general remark.)

Comment thread documentation/glossary/glossary.adoc Outdated
Comment thread documentation/glossary/glossary.adoc Outdated
@PaulRMellor
Copy link
Copy Markdown
Contributor Author

I left some nits. I think it looks good, just not entirely sure about the purpose. Without some links for more details, it does not seem so useful. (Just to be clear - I do not have an issue with this getting merged. Just a general remark.)

Thanks Jakub. The idea is to give us a quick-reference glossary that helps keep our terminology consistent and easier to onboard with. It also creates a landing page for SEO, so users searching for specific terms can find them more easily. You're right, adding a few links could make it more useful. Happy to include some where they add value.

Signed-off-by: prmellor <pmellor@redhat.com>
Signed-off-by: prmellor <pmellor@redhat.com>
Copy link
Copy Markdown
Member

@see-quick see-quick left a comment

Choose a reason for hiding this comment

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

I really like this glossary! 👍 Thanks @PaulRMellor.

Copy link
Copy Markdown
Member

@scholzj scholzj left a comment

Choose a reason for hiding this comment

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

Thanks @PaulRMellor

Comment thread documentation/modules/glossary/c.adoc Outdated
Comment thread documentation/modules/glossary/c.adoc Outdated
Comment thread documentation/modules/glossary/c.adoc Outdated
Comment thread documentation/modules/glossary/k.adoc Outdated
Comment thread documentation/modules/glossary/m.adoc Outdated
Signed-off-by: prmellor <pmellor@redhat.com>
@PaulRMellor
Copy link
Copy Markdown
Contributor Author

Thanks for the comments @ppatierno
All addressed

Copy link
Copy Markdown
Member

@ppatierno ppatierno left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

Copy link
Copy Markdown
Member

@im-konge im-konge left a comment

Choose a reason for hiding this comment

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

LGTM, this is great! Thanks Paul :)

@PaulRMellor PaulRMellor merged commit 5cbc705 into strimzi:main Oct 8, 2025
22 checks passed
@PaulRMellor PaulRMellor deleted the docs_glossary-of-terms branch October 8, 2025 08:27
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.

5 participants