Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the Strimzi documentation with little more clarification #9672

Merged
merged 1 commit into from
Feb 12, 2024

Conversation

vinod827
Copy link
Contributor

@vinod827 vinod827 commented Feb 10, 2024

Type of change

  • Documentation

Description

This pull request refines the instructions regarding naming conventions for module files. Specifically, it clarifies that the module file should be named the same as the anchor used in it, which should also align with or resemble the module heading. Additionally, it suggests separating these elements with dashes for clarity.

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

Copy link
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.

Please fix the DCO signoff - the instructions are under the Details link next tot he DCO status.

@scholzj scholzj added this to the 0.40.0 milestone Feb 10, 2024
Copy link
Contributor

@PaulRMellor PaulRMellor left a comment

Choose a reason for hiding this comment

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

Thanks

@scholzj scholzj merged commit 610c963 into strimzi:main Feb 12, 2024
13 checks passed
@scholzj
Copy link
Member

scholzj commented Feb 12, 2024

Thanks for the PR @vinod827

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants