-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
📖 book: Add API reference page #6067
📖 book: Add API reference page #6067
Conversation
/assign @fabriziopandini |
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.
a couple of tiny nits otherwise
/lgtm
251a2c0
to
7b34233
Compare
Thx, ~ fixed as suggested |
Thanks! /lgtm |
big +1! |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: fabriziopandini The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What this PR does / why we need it:
I don't have strong opinions on how exactly we link the API references, but I think we should do it.
Just adding links to specialized websites seems to be a low-maintenance way to provide this kind of information to our users (which might not know pages like doc.crds.dev). Also we can profit from improvements in those pages or swap them out easily if we find better ones.
Notes:
reference.md
. I don't have a strong opinion about that.Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)
format, will close the issue(s) when PR gets merged):Fixes #4484