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.

Sign up for GitHub

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

Jump to bottom

fix hyperlinks in the 'overview' section #1418

Merged
merged 1 commit into from
Sep 29, 2021
Merged

fix hyperlinks in the 'overview' section #1418

merged 1 commit into from
Sep 29, 2021

Conversation

pramodrj07
Copy link
Contributor

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

@pramodrj07
fix hyperlinks in the 'overview' section
2e997e0 
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

terrytangyuan
terrytangyuan reviewed Sep 22, 2021
View reviewed changes
README.md
@@ -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

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. 👍🏽

gaocegege
gaocegege reviewed Sep 24, 2021
View reviewed changes
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 •
edited

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

terrytangyuan
terrytangyuan approved these changes Sep 29, 2021
View reviewed changes
Copy link
Member

@terrytangyuan terrytangyuan left a comment •
edited

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
@pramodrj07 @Jeffwan
fix hyperlinks in the 'overview' section (kubeflow#1418)
349815e 
hyperlinks now point to the latest api reference files.
issue - kubeflow#1411
This was referenced Oct 3, 2021
Closed
Merged
Jeffwan added a commit to Jeffwan/tf-operator that referenced this pull request Oct 3, 2021
@Jeffwan
fix hyperlinks in the 'overview' section (kubeflow#1418)
bffab0f 
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
@Jeffwan
Cherry pick #1415 #1418 to v1.3-branch (#1428)
e0b872e 
* Feature/support pytorchjob set queue of volcano (#1415)

* support pytorch use volcano-queue

* support pytorch use volcano-queue

Signed-off-by: bert.li <qiankun.li@qq.com>

* set SchedulingPolicy for runPolicy

Signed-off-by: bert.li <qiankun.li@qq.com>

* 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
@pramodrj07
consistent naming for better readability
d0739b0 
this change is as per the discussion in the link below
kubeflow#1418 (comment)
@pramodrj07 pramodrj07 mentioned this pull request Oct 14, 2021
Merged
pramodrj07 added a commit to pramodrj07/tf-operator that referenced this pull request Nov 2, 2021
@pramodrj07
consistent naming for better readability
77cc55c 
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
@pramodrj07
consistent naming for better readability (#1449)
72e4387 
* 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
Reviewers

@gaocegege gaocegege gaocegege left review comments

@terrytangyuan terrytangyuan terrytangyuan approved these changes

@jinchihe jinchihe Awaiting requested review from jinchihe

Assignees

@terrytangyuan terrytangyuan

@Jeffwan Jeffwan

Labels
approved lgtm ok-to-test size/XS
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@pramodrj07 @aws-kf-ci-bot @Jeffwan @google-oss-robot @terrytangyuan @gaocegege