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

docs(api): adds formatting for lists to the descriptions of the API properties #9646

Merged
merged 2 commits into from
Feb 7, 2024

Conversation

PaulRMellor
Copy link
Contributor

@PaulRMellor PaulRMellor commented Feb 6, 2024

Documentation

Updates the API reference doc generator so that formatting is applied to the description column of the tables. Some cells have lists, so these are now rendered properly.

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.40.0 milestone Feb 6, 2024
@PaulRMellor PaulRMellor self-assigned this Feb 6, 2024
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.

You will likely need tp update the CRDs in the Helm Chart as well?

@PaulRMellor
Copy link
Contributor Author

You will likely need tp update the CRDs in the Helm Chart as well?

Right. Thanks. Not sure why it didn't show up in the first build. I needed to run a couple more times for the update to pop out.

@PaulRMellor PaulRMellor merged commit b363325 into strimzi:main Feb 7, 2024
13 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