Use the crd-ref-docs to generate the docs for CRDs API automatically. #1527
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
Signed-off-by: Ye Cao <caoye.cao@alibaba-inc.com>
✅ Deploy Preview for v6d ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Ye Cao <caoye.cao@alibaba-inc.com>
sighingnow
approved these changes
Aug 17, 2023
k8s/config.yaml
Outdated
| - "(Elasticsearch|Kibana|ApmServer)Health$" | ||
| - "(Elasticsearch|Kibana|ApmServer|Reconciler)Status$" | ||
| - "ElasticsearchSettings$" | ||
| - "Associa(ted|tor|tionStatus|tionConf)$" |
There was a problem hiding this comment.
We don't have those types. Remove it.
I think it doesn't matter, you can see a similar doc like https://github.com/elastic/cloud-on-k8s/blob/main/docs/reference/api-docs.asciidoc. |
Signed-off-by: Ye Cao <caoye.cao@alibaba-inc.com>
dashanji
force-pushed
the
revise-CRDs-doc
branch
from
ac9f0f4
to
fb9299f
Compare
Signed-off-by: Ye Cao <caoye.cao@alibaba-inc.com>
Signed-off-by: Ye Cao <caoye.cao@alibaba-inc.com>
sighingnow
reviewed
Aug 17, 2023
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.
What do these changes do?
Fixes #1522. Wait for the upstream default markers ready, then it's enough for generating the essential APIs for users.