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

fix hyperlinks in the 'overview' section #1418

Merged
merged 1 commit into from
Sep 29, 2021

Conversation

pramodrj07
Copy link
Contributor

hyperlinks now point to the latest api reference files.
issue - #1411

hyperlinks now point to the latest api reference files.
issue - kubeflow#1411
@aws-kf-ci-bot
Copy link
Contributor

Hi @pramodrj07. Thanks for your PR.

I'm waiting for a kubeflow member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@pramodrj07
Copy link
Contributor Author

/assign @Jeffwan

@@ -12,9 +12,9 @@ run distributed or non-distributed TensorFlow/PyTorch/MXNet/XGBoost jobs on Kube

- For a complete reference of the custom resource definitions, please refer to the API Definition.
- [Tensorflow API Definition](pkg/apis/tensorflow/v1/types.go)
Copy link
Member

Choose a reason for hiding this comment

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

We probably want to make these consistent. Seems like https://github.com/kubeflow/tf-operator/blob/master/pkg/apis/tensorflow/v1/types.go is still there.

Copy link
Contributor Author

@pramodrj07 pramodrj07 Sep 22, 2021

Choose a reason for hiding this comment

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

Are you suggesting that we change the name of this file?

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps changing those files to types.go would be good since they are already under each particular framework.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good. I will make the changes in a new PR and link it to this one.

Copy link
Member

Choose a reason for hiding this comment

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

Hmm why not reusing this same PR? I don't think the changes here are needed and will be reverted by the new PR anyways.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh yes. that makes sense. I will update the change here itself. 👍🏽

Copy link
Member

@gaocegege gaocegege left a comment

Choose a reason for hiding this comment

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

/ok-to-test

@Jeffwan
Copy link
Member

Jeffwan commented Sep 29, 2021

Do we want to merge doc fix first and create an issue to track the code improvement or finish everything is this PR? /cc @terrytangyuan @gaocegege

Copy link
Member

@terrytangyuan terrytangyuan left a comment

Choose a reason for hiding this comment

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

We can merge this first as people are looking at these references on REAME so it’s better to fix now.

/lgtm

@google-oss-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: terrytangyuan

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

@google-oss-robot google-oss-robot merged commit 4aac6d1 into kubeflow:master Sep 29, 2021
@terrytangyuan
Copy link
Member

@pramodrj07 Feel free to submit follow up PRs for enhancements.

Jeffwan pushed a commit to Jeffwan/tf-operator that referenced this pull request Oct 3, 2021
hyperlinks now point to the latest api reference files.
issue - kubeflow#1411
Jeffwan added a commit to Jeffwan/tf-operator that referenced this pull request Oct 3, 2021
hyperlinks now point to the latest api reference files.
issue - kubeflow#1411
google-oss-robot pushed a commit that referenced this pull request Oct 3, 2021
* Feature/support pytorchjob set queue of volcano (#1415)

* support pytorch use volcano-queue

* support pytorch use volcano-queue

Signed-off-by: bert.li <[email protected]>

* set SchedulingPolicy for runPolicy

Signed-off-by: bert.li <[email protected]>

* use pytorchjob.Spec.RunPolicy directly

* fix hyperlinks in the 'overview' section (#1418)

hyperlinks now point to the latest api reference files.
issue - #1411
pramodrj07 added a commit to pramodrj07/tf-operator that referenced this pull request Oct 14, 2021
this change is as per the discussion in the link below
kubeflow#1418 (comment)
pramodrj07 added a commit to pramodrj07/tf-operator that referenced this pull request Nov 2, 2021
this change is as per the discussion in the link below
kubeflow#1418 (comment)
google-oss-robot pushed a commit that referenced this pull request Nov 3, 2021
* consistent naming for better readability

this change is as per the discussion in the link below
#1418 (comment)

* update the respective naming changes in README.md
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.

6 participants