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

Update TFJob docs with information about monitoring. #107

Merged
merged 1 commit into from
Aug 2, 2018

Conversation

jlewi
Copy link
Contributor

@jlewi jlewi commented Jul 29, 2018

  • Move over the documentation in kubeflow/tf-operator/README.md and
    update it for v1alpha2.

  • Add a what is TFJob section that describes the TFJob

    • Provide information about the spec
    • Provide information about exit codes.
  • Provide stackdriver sections for both the legacy and new Kubernetes
    stackdriver.

  • Add a troubleshooting section.


This change is Reviewable

* Move over the documentation in kubeflow/tf-operator/README.md and
  update it for v1alpha2.

* Add a what is TFJob section that describes the TFJob
  * Provide information about the spec
  * Provide information about exit codes.

* Provide stackdriver sections for both the legacy and new Kubernetes
  stackdriver.

* Add a troubleshooting section.
jlewi added a commit to jlewi/k8s that referenced this pull request Jul 29, 2018
* We should direct users to the official documentation and remove
  the documentation in the README.md

* kubeflow/website#107 will update the website to include all information
  currently in the README as well as other information

* README.md is outdated; e.g. it is still referring to v1alpha1

Fix kubeflow#760
@jlewi
Copy link
Contributor Author

jlewi commented Jul 29, 2018

/assign @kunmingg

k8s-ci-robot pushed a commit to kubeflow/training-operator that referenced this pull request Jul 30, 2018
* We should direct users to the official documentation and remove
  the documentation in the README.md

* kubeflow/website#107 will update the website to include all information
  currently in the README as well as other information

* README.md is outdated; e.g. it is still referring to v1alpha1

Fix #760
Copy link
Member

@abhi-g abhi-g left a comment

Choose a reason for hiding this comment

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

This document in general looks great and really informative.

@@ -74,14 +204,14 @@ Typically you will want to change the following values

1. Attach PV's if you want to use PVs for storage.

## Submitting a TensorFlow training job
### Submitting a TensorFlow training job
Copy link
Member

Choose a reason for hiding this comment

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

Lines 207 - 271 seem to be duplicate of lines 143-206.

@kunmingg
Copy link
Contributor

kunmingg commented Aug 1, 2018

/lgtm
Thanks, very detailed docs.

@jlewi
Copy link
Contributor Author

jlewi commented Aug 2, 2018

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jlewi

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 295e96e into kubeflow:master Aug 2, 2018
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