-
Notifications
You must be signed in to change notification settings - Fork 761
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
Added the framework for API references. #514
Conversation
/assign @richardsliu |
/hold Holding this one until I can merge it with the references in #516 |
Fixes #519 |
/lgtm |
Preview: https://deploy-preview-514--competent-brattain-de2d6d.netlify.com/docs/reference/overview/ The ordering of the pages is still a little weird, but I think it's good enough to commit. I'll continue working on the ordering when we add additional reference docs. |
/hold cancel |
@richardsliu Please would you review and approve if you're happy with the changes. |
Looks great. |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: richardsliu 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 |
I've added an index page for API references, in preparation for the TFJob reference described in issue kubeflow/training-operator#731
I've also added a link from the TFJob user guide to the (upcoming) reference, and configured a compact left-hand nav to make it easier to see all the doc sections.
Note that this PR isn't ready to submit, as it assumes the existence of the v1beta2 API reference for TFJob.
This change is![Reviewable](https://camo.githubusercontent.com/23b05f5fb48215c989e92cc44cf6512512d083132bd3daf689867c8d9d386888/68747470733a2f2f72657669657761626c652e696f2f7265766965775f627574746f6e2e737667)