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

Added the framework for API references. #514

Merged
merged 3 commits into from
Mar 5, 2019

Conversation

sarahmaddox
Copy link
Contributor

@sarahmaddox sarahmaddox commented Mar 3, 2019

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

@sarahmaddox
Copy link
Contributor Author

/assign @richardsliu
/uncc @gaoning777
/uncc @lluunn

@sarahmaddox sarahmaddox changed the title WIP: Added an index page for API references. Added an index page for API references. Mar 5, 2019
@sarahmaddox
Copy link
Contributor Author

/hold

Holding this one until I can merge it with the references in #516

@sarahmaddox
Copy link
Contributor Author

Fixes #519

@richardsliu
Copy link
Collaborator

/lgtm

@k8s-ci-robot k8s-ci-robot removed the lgtm label Mar 5, 2019
@sarahmaddox sarahmaddox changed the title Added an index page for API references. Added the framework for API references. Mar 5, 2019
@sarahmaddox
Copy link
Contributor Author

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.

@sarahmaddox
Copy link
Contributor Author

/hold cancel

@sarahmaddox
Copy link
Contributor Author

@richardsliu Please would you review and approve if you're happy with the changes.

@richardsliu
Copy link
Collaborator

Looks great.
/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

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

@k8s-ci-robot k8s-ci-robot merged commit 9c2014e into kubeflow:master Mar 5, 2019
@sarahmaddox sarahmaddox deleted the reflinks branch March 10, 2019 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants