v2: update CRD docs and doc generation #396
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
Comment on lines
+509
to
+510
| // tuning is required, the CLI flags can be manually overridden using | ||
| // `statefulset.additionalRedpandaCmdFlags`. |
There was a problem hiding this comment.
Suggested change
| // tuning is required, the CLI flags can be manually overridden using | |
| // `statefulset.additionalRedpandaCmdFlags`. | |
| // tuning is required, the CLI flags can be manually overridden using | |
| // `statefulset.additionalRedpandaCmdFlags` in Redpanda helm chart. |
There was a problem hiding this comment.
I don't think we need to specify helm chart here. The mentioned path is equally correct for the operator. Perhaps we should qualify it with spec.clusterSpec though?
There was a problem hiding this comment.
I think the spec.clusterSpec would help me orientate. Sometimes I'm confused wheter it's Operator helm chart values or Redpanda helm chart values or Redpanda custom resource 🤯
|
I think the needs to be perform to pass lint test. |
chrisseto
force-pushed
the
chris/p/crd-doc-updates
branch
from
eb655dc to
78df746
Compare
RafalKorepta
approved these changes
Jan 16, 2025
This commit transplants the documentation for the recent redpanda helm chart update to their relevant place in the Redpanda CRD. In addition, it adds a configuration for crd-doc-ref to allow developers to review how documentation changes will be presented in our public docs ahead of merging. This commit also proactively changes instances of markdown URLs to asciidoc compatible links and adds a linter to prevent regressions.
chrisseto
force-pushed
the
chris/p/crd-doc-updates
branch
from
78df746 to
41e8868
Compare
|
I used https://asciidoctor.org/ to render it into HTML. The adoc alone isn't super useful but its more than nothing. |
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.
This commit transplants the documentation for the recent redpanda helm chart update to their relevant place in the Redpanda CRD. In addition, it adds a configuration for crd-doc-ref to allow developers to review how documentation changes will be presented in our public docs ahead of merging.
This commit also proactively changes instances of markdown URLs to asciidoc compatible links and adds a linter to prevent regressions.