Point config at the redpanda-operator repo #956
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We now host the config for the `crd-ref-docs` tool in the `redpanda-operator` repo so that the K8s team can manage it: https://github.com/redpanda-data/redpanda-operator/pull/396/files#diff-0cb4f1303ff20a2dac37c99d821bff1eded9843e59401d605c4c8314d8762c3e
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
chrisseto
approved these changes
Jan 21, 2025
There was a problem hiding this comment.
Preview site looks good to me!
The one maybe oddity is that you have to click twice to get to the actual references:
Still, no invalid type and fewer broken links is a win 🎉 (Disclaimer I did not check all links so I'm just guessing that some are still broken)
|
Thanks for this, Chris! The extra click is a scalability thing. We have a parent index page so that in the future, we can automatically list all available CRDs/versions on that page. |
asimms41
reviewed
Jan 21, 2025
There was a problem hiding this comment.
Just some observations...
- There are some parts of the spec that are not populated. For example RPControllers, PodTemplate, PodSpecApplyConfiguration. Should these be visible?
- Links to docs (and other resources) are shown as html links. For example TopicSpec. I take it that is a limitation?
- Should all config be at the same level? You need to drill down to find certain objects, fields/properties etc but the in-page navigation shows everything at the same level. Also, some fields/properties have the type shown, for example AuthorizationType (string).
|
Thanks Angela, I'll add these items to a separate Jira on improving the CRD spec docs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Review deadline: 21 Jan
We now host the config for the
crd-ref-docstool in theredpanda-operatorrepo so that the K8s team can manage it: https://github.com/redpanda-data/redpanda-operator/pull/396/files#diff-0cb4f1303ff20a2dac37c99d821bff1eded9843e59401d605c4c8314d8762c3ePage previews
https://deploy-preview-956--redpanda-docs-preview.netlify.app/current/reference/k-crd/
Checks