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

Fix API reference for the VolumeMounts object #10417

Merged
merged 1 commit into from
Aug 5, 2024

Conversation

scholzj
Copy link
Member

@scholzj scholzj commented Aug 5, 2024

Type of change

  • Bugfix
  • Documentation

Description

The volumeMounts field in the container template references a Kubernetes API through a Fabric8 object. This results in a table in the API reference without any descriptions: https://strimzi.io/docs/operators/in-development/full/configuring.html#type-VolumeMount-reference

This PR adds the KubeLink annotation to link to the Kubernetes API docs instead.

It also removes the unnecessary JsonProperty annotation.

Checklist

  • Update documentation

Signed-off-by: Jakub Scholz <www@scholzj.com>
@scholzj scholzj added this to the 0.43.0 milestone Aug 5, 2024
@scholzj scholzj requested a review from a team August 5, 2024 15:00
@scholzj scholzj merged commit 666ca93 into strimzi:main Aug 5, 2024
13 checks passed
@scholzj scholzj deleted the docs-fix-volume-mount-reference branch August 5, 2024 17:59
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.

3 participants