-
Notifications
You must be signed in to change notification settings - Fork 126
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: [WIP] PoC draft of CRD reference pages #889
Conversation
Signed-off-by: Meg McRoberts <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
content-wise, this looks good, but i think we can put most of the content of this file into the actual docs comments in the code and then auto generate the markdown from there 🤷🏼
|
||
## Synopsis | ||
|
||
```yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we have code examples of our CRDs already prepared (mostly). I would use a link here instead of actual code.
You can find the examples here: #888
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would love to embed this content in the source and have it autogenerated! But I figured I needed to hand-write a few pages to work things out and then we know what we want the tools to do.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would very much like the "Synopsis" to show on the reference page that is displayed in the documentation, with a format similar to what I have here. But it would be ideal if that were pulled from the software source so it does not need to be maintained manually! I very much like the idea of just pointing to existing examples -- that allows people to see how this CRD fits in the "big picture" as it were.
Signed-off-by: Meg McRoberts <[email protected]>
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #889 +/- ##
==========================================
- Coverage 58.64% 58.60% -0.04%
==========================================
Files 97 97
Lines 7552 7552
==========================================
- Hits 4429 4426 -3
- Misses 2933 2935 +2
- Partials 190 191 +1
Flags with carried forward coverage won't be shown. Click here to find out more. |
Signed-off-by: Meg McRoberts <[email protected]>
Kudos, SonarCloud Quality Gate passed! |
This PR is superceded by #1083 . |
This is a quick rough draft of what I envision as a reference page for a CRD, presented for discussion.
Caveats:
#778