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

Pytorch documentation for v1beta1 and v1beta2 #545

Merged
merged 6 commits into from
Mar 28, 2019

Conversation

richardsliu
Copy link
Collaborator

@richardsliu richardsliu commented Mar 19, 2019

This change is Reviewable

@richardsliu
Copy link
Collaborator Author

/assign @johnugeorge

@sarahmaddox
Copy link
Contributor

/assign

@sarahmaddox
Copy link
Contributor

@@ -0,0 +1,226 @@
+++
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please would you also add a file at the following location:
content/docs/reference/pytorchjob/v1beta1/_index.md

With file content similar to this one:
https://github.com/kubeflow/website/blob/master/content/docs/reference/tfjob/v1beta1/_index.md

And similar for:
content/docs/reference/pytorchjob/v1beta2/_index.md

These index files will sort out the navigation structure in the left-hand menu of the doc site.

<td>
<code>cleanPodPolicy</code></br>
<em>
<a href="/docs/reference/tfjob/v1beta1/common/#CleanPodPolicy">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems odd to link to a tfjob doc here. Actually, doing a search shows that there are a number of references to tfjob. Is this a copy/paste error?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is because the "common" API types are currently part of the tf-operator repository. We have a proposal to move these to a standalone repo: kubeflow/training-operator#960.

@richardsliu
Copy link
Collaborator Author

@sarahmaddox Done

@sarahmaddox
Copy link
Contributor

Thanks.

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sarahmaddox

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 fa1af46 into kubeflow:master Mar 28, 2019
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.

4 participants