Skip to content
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

Merged
merged 1 commit into from
Feb 11, 2022

Conversation

sbueringer
Copy link
Member

@sbueringer sbueringer commented Feb 4, 2022

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:

  • It's non-trivial/maybe impossible to add an external link to the mdbook sidebar, but I think it's good to have a separate book page anyway, given that we have multiple APIs and there will be more with RuntimeExtensions.
  • An alternative would be to integrate the API references in the currently almost empty reference.md. I don't have a strong opinion about that.
  • For comparison: Kubernetes references: https://kubernetes.io/docs/reference/ https://kubernetes.io/docs/reference/kubernetes-api/

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

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 4, 2022
@sbueringer
Copy link
Member Author

/assign @fabriziopandini

Copy link
Contributor

@killianmuldoon killianmuldoon left a 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

docs/book/src/reference/api_reference.md Outdated Show resolved Hide resolved
docs/book/src/reference/api_reference.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 4, 2022
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 4, 2022
@sbueringer
Copy link
Member Author

Thx, ~ fixed as suggested

@killianmuldoon
Copy link
Contributor

Thanks!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 4, 2022
@fabriziopandini
Copy link
Member

big +1!
/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 11, 2022
@k8s-ci-robot k8s-ci-robot merged commit 9d4d6b4 into kubernetes-sigs:main Feb 11, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.2 milestone Feb 11, 2022
@sbueringer sbueringer deleted the pr-add-reference branch February 11, 2022 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate reference documentation in the book
4 participants