Update REAME example links for v1alpha1 #452

alexandraj777 · 2019-04-08T22:46:53Z

This change is

k8s-ci-robot · 2019-04-08T22:47:06Z

Hi @alexandraj777. 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.

alexandraj777 · 2019-04-08T22:47:35Z

Eeek, commit message typo 😱

alexandraj777 · 2019-04-08T22:47:54Z

/assign @jlewi

andreyvelich · 2019-04-08T23:13:34Z

README.md

 ```

 This is example for pytorch operator

 ```
-kubectl create -f https://raw.githubusercontent.com/kubeflow/katib/master/examples/pytorchjob-example.yaml
+kubectl create -f https://raw.githubusercontent.com/kubeflow/katib/master/examples/v1alpha1/pytorchjob-example.yaml
 ```

 You can check status of StudyJob


@alexandraj777 Thank you for your PR!
Should we also update the link here: https://github.com/kubeflow/katib/pull/452/files#diff-04c6e90faac2675aa89e2176d2eec7d8R161
and here: https://github.com/kubeflow/katib/pull/452/files#diff-04c6e90faac2675aa89e2176d2eec7d8R362 ?

hougangliu · 2019-04-08T23:18:28Z

README.md

@@ -189,21 +189,21 @@ spec:
 If you are not using GKE and you don't have StorageClass for dynamic volume provisioning at your cluster, you have to create pvc and pv

 ```
-kubectl create -f https://raw.githubusercontent.com/kubeflow/katib/master/examples/tfevent-volume/tfevent-pvc.yaml
+kubectl create -f https://raw.githubusercontent.com/kubeflow/katib/master/examples/v1alpha1/tfevent-volume/tfevent-pvc.yaml


Thanks!
please also update linke of line 93, too.
In fact, links in https://github.com/kubeflow/katib/blob/master/docs/developer-guide.md and https://github.com/kubeflow/katib/blob/master/docs/rest-api.md need be updated, too

alexandraj777 · 2019-04-09T05:32:25Z

@hougangliu @andreyvelich thanks for the review!

Seems like there's a lot of places to update v1 links. Here, I've only updated the examples/ links, but some of the ones you've pointed out are from the pkg folder and the manifests folder. When I do these in my own repos, I generally like to do PRs based on easy search-and-replaces, with roughly one PR per search and replace. So, I would normally do one PR for examples/ links, one PR for replacing pkg/ links, one for manifests/ links.

I'm not too familiar with how you like to do PRs in this codebase, but would it be ok with you to just leave this PR for the examples/ links, and do followup PRs for the pkg/ changes and the manifests/ changes? Or is separate PRs too much load on reviewers? If not, I'm happy to add the changes to this PR.

johnugeorge · 2019-04-09T07:56:40Z

/ok-to-test

jlewi · 2019-04-09T21:51:21Z

/assign @andreyvelich
/assign @hougangliu
/unassign @jlewi

jlewi · 2019-04-09T21:51:32Z

/ok-to-test

richardsliu · 2019-04-09T23:44:40Z

@alexandraj777 If it's not too much trouble could you fix the other links in the same PR? It is generally cleaner and makes things easier to track. Thanks!

alexandraj777 · 2019-04-10T00:19:13Z

@richardsliu that's reasonable, will do

alexandraj777 · 2019-04-10T01:12:25Z

Ok I think I've caught all of the changes between pkg, examples, and manifests. The biggest change was rewriting parts of the pkg/api/README.md file to include links for both v1alpha1 and v1alpha2 links. I've attempted to manually verify that all links exist.

This should be ready to go! @hougangliu @andreyvelich anything I missed?

hougangliu · 2019-04-10T01:17:28Z

@alexandraj777 thanks for your PR.
/lgtm

richardsliu · 2019-04-10T01:19:27Z

Thanks Alexandra.
/approve

k8s-ci-robot · 2019-04-10T01:19:30Z

[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:

~~OWNERS~~ [richardsliu]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

andreyvelich · 2019-04-10T01:21:02Z

docs/developer-guide.md

@@ -22,7 +22,7 @@ You can build all images from source.

 ## Implement new suggestion algorithm


I think, we should also change path here: https://github.com/kubeflow/katib/pull/452/files#diff-ba23e0f18c79cb873ac5375367524cfaL20.

andreyvelich · 2019-04-10T01:21:48Z

pkg/api/README.md

@@ -4,10 +4,17 @@ Manager service is an API for core component.
 Suggestion service is an API for Suggestion services.
 EarlyStopping service is an API for EarlyStopping services.

-## Documentation
-Please refer to [api.md](./gen-doc/api.md).
+## v1alpha1 Documentation


Probably, just name it Documentation? Since we have v1alpha1 and v1alpha2 links here.

andreyvelich · 2019-04-10T01:22:41Z

/hold

andreyvelich · 2019-04-10T01:24:16Z

@alexandraj777 Thanks for your changes! I left 3 commentaries.

andreyvelich · 2019-04-10T01:28:20Z

examples/v1alpha1/README.md

@@ -369,7 +369,7 @@ batch2 accuracy=0.8
 Validation-accuracy=0.75
 ```
 The metrics collector will collect all logs of metrics.
-The manifest of metrics collector is also generated from template and defined [here](/manifests/studyjobcontroller/metricsControllerConfigMap.yaml).
+The manifest of metrics collector is also generated from template and defined [here](./manifests/v1alpha1/studyjobcontroller/metricsControllerConfigMap.yaml).


This link doesn't work correctly for me.
As well, I found this line with wrong link:
https://github.com/kubeflow/katib/pull/452/files#diff-be7f7f1b07a698ff4c53ad0e30462b67R202

alexandraj777 · 2019-04-10T18:29:18Z

@andreyvelich I've made changes based on all of your comments!

andreyvelich · 2019-04-10T19:58:29Z

Thank you!
/lgtm
/hold cancel

Update REAME example links for v1alpha1

0282b53

k8s-ci-robot requested review from garganubhav and libbyandhelen April 8, 2019 22:46

k8s-ci-robot added needs-ok-to-test size/S labels Apr 8, 2019

k8s-ci-robot assigned jlewi Apr 8, 2019

andreyvelich reviewed Apr 8, 2019

View reviewed changes

hougangliu reviewed Apr 8, 2019

View reviewed changes

k8s-ci-robot added ok-to-test and removed needs-ok-to-test labels Apr 9, 2019

k8s-ci-robot assigned andreyvelich and hougangliu and unassigned jlewi Apr 9, 2019

Alexandra Johnson added 3 commits April 9, 2019 17:50

pkg/api/api.proto -> pkg/api/v1alpha1/api.proto

1e11069

pkg/api/gen-doc/api.md -> pkg/api/v1alpha1/gen-doc/api.md

c19ea4e

Links in pkg/api/README.md need to be doubled up for alpha1 and alpha2

7ed905d

k8s-ci-robot added size/M and removed size/S labels Apr 10, 2019

manifests -> manifests/v1alpha1

3bb70db

k8s-ci-robot added the lgtm label Apr 10, 2019

k8s-ci-robot added the approved label Apr 10, 2019

andreyvelich reviewed Apr 10, 2019

View reviewed changes

k8s-ci-robot added the do-not-merge/hold label Apr 10, 2019

andreyvelich reviewed Apr 10, 2019

View reviewed changes

Alexandra Johnson added 4 commits April 10, 2019 11:24

Fix another examples link

c21969c

No more relative link

8474e3c

rename header

e546268

update scripts link

1104560

k8s-ci-robot removed the lgtm label Apr 10, 2019

k8s-ci-robot added lgtm and removed do-not-merge/hold labels Apr 10, 2019

k8s-ci-robot merged commit 33e8e30 into kubeflow:master Apr 10, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update REAME example links for v1alpha1 #452

Update REAME example links for v1alpha1 #452

alexandraj777 commented Apr 8, 2019 •

edited by jlewi

Loading

k8s-ci-robot commented Apr 8, 2019

alexandraj777 commented Apr 8, 2019

alexandraj777 commented Apr 8, 2019

andreyvelich Apr 8, 2019

hougangliu Apr 8, 2019 •

edited

Loading

alexandraj777 commented Apr 9, 2019

johnugeorge commented Apr 9, 2019

jlewi commented Apr 9, 2019

jlewi commented Apr 9, 2019

richardsliu commented Apr 9, 2019

alexandraj777 commented Apr 10, 2019

alexandraj777 commented Apr 10, 2019

hougangliu commented Apr 10, 2019

richardsliu commented Apr 10, 2019

k8s-ci-robot commented Apr 10, 2019

andreyvelich Apr 10, 2019

andreyvelich Apr 10, 2019

andreyvelich commented Apr 10, 2019

andreyvelich commented Apr 10, 2019 •

edited

Loading

andreyvelich Apr 10, 2019 •

edited

Loading

alexandraj777 commented Apr 10, 2019

andreyvelich commented Apr 10, 2019

		@@ -22,7 +22,7 @@ You can build all images from source.

		## Implement new suggestion algorithm

Update REAME example links for v1alpha1 #452

Update REAME example links for v1alpha1 #452

Conversation

alexandraj777 commented Apr 8, 2019 • edited by jlewi Loading

k8s-ci-robot commented Apr 8, 2019

alexandraj777 commented Apr 8, 2019

alexandraj777 commented Apr 8, 2019

andreyvelich Apr 8, 2019

Choose a reason for hiding this comment

hougangliu Apr 8, 2019 • edited Loading

Choose a reason for hiding this comment

alexandraj777 commented Apr 9, 2019

johnugeorge commented Apr 9, 2019

jlewi commented Apr 9, 2019

jlewi commented Apr 9, 2019

richardsliu commented Apr 9, 2019

alexandraj777 commented Apr 10, 2019

alexandraj777 commented Apr 10, 2019

hougangliu commented Apr 10, 2019

richardsliu commented Apr 10, 2019

k8s-ci-robot commented Apr 10, 2019

andreyvelich Apr 10, 2019

Choose a reason for hiding this comment

andreyvelich Apr 10, 2019

Choose a reason for hiding this comment

andreyvelich commented Apr 10, 2019

andreyvelich commented Apr 10, 2019 • edited Loading

andreyvelich Apr 10, 2019 • edited Loading

Choose a reason for hiding this comment

alexandraj777 commented Apr 10, 2019

andreyvelich commented Apr 10, 2019

alexandraj777 commented Apr 8, 2019 •

edited by jlewi

Loading

hougangliu Apr 8, 2019 •

edited

Loading

andreyvelich commented Apr 10, 2019 •

edited

Loading

andreyvelich Apr 10, 2019 •

edited

Loading