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): cleans up property descriptions #10318

Merged
merged 5 commits into from
Jul 16, 2024

Conversation

PaulRMellor
Copy link
Contributor

@PaulRMellor PaulRMellor commented Jul 9, 2024

Documentation

API reference cleanup

  • Cleans up repetition of descriptions in and outside tables in the API reference guide.
  • Removes all the sub-sections that describe the same properties in the tables.
  • Updates the table descriptions in the code where necessary.
  • Retains any useful information introducing the schema, with examples.
  • User quotas content was moved to Deploying guide

Note that ACL descriptions were re-added for the AclRule schema (removed in #9207)

There are still some lengthy descriptions for one or two tables, such as for the CruiseControlSpec schema.
Out of scope for this PR, but as a phase 2 we could look to move such additional content and for each schema have the following only:

schema_name

  • example configuration
  • property descriptions

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.43.0 milestone Jul 9, 2024
@PaulRMellor PaulRMellor requested a review from a team July 9, 2024 09:03
@PaulRMellor PaulRMellor self-assigned this Jul 9, 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.

One more it. But LGTM otherwise. I think you might also need to update the generated files to make the build pass.

@PaulRMellor
Copy link
Contributor Author

Thanks for the additional comments @scholzj

@scholzj scholzj merged commit 9047696 into strimzi:main Jul 16, 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.

2 participants