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

Move katib docs to website #72

Closed
jlewi opened this issue Jun 29, 2018 · 7 comments
Closed

Move katib docs to website #72

jlewi opened this issue Jun 29, 2018 · 7 comments
Assignees

Comments

@jlewi
Copy link
Contributor

jlewi commented Jun 29, 2018

Docs were added in kubeflow/kubeflow#989; we should move them to our webiste.

@amsaha
Copy link
Contributor

amsaha commented Jul 28, 2018

/assign

@amsaha
Copy link
Contributor

amsaha commented Jul 28, 2018

Waiting on #105.

@amsaha
Copy link
Contributor

amsaha commented Jul 29, 2018

@jlewi @sarahmaddox

Should we move the Katib documentation to "Guides -> Components" or should it be part of the "Getting Started" section?

screen shot 2018-07-29 at 9 53 22 am

@sarahmaddox
Copy link
Contributor

@amsaha @jlewi My 2c is that the Katib docs should be part of "Guides -> Components". Currently the Katib guide is quite short, but we may expand it later so that it becomes more than just a getting-started guide for Katib.

My thinking is that the "Getting Started" section should focus on getting started with Kubeflow as a whole, rather than on getting started with components of it. So, I think it's OK for the Minikube and gke quickstarts to be in the getting-started section, but the quickstarts for each component belong rather in the "Guides" section.

An added advantage of this thinking is that we can keep the getting-started section short, which makes it simpler for new users.

@jlewi
Copy link
Contributor Author

jlewi commented Jul 29, 2018

I agree with @sarahmaddox.

Katib should be its own section "Hyperparameter Tuning"

@amsaha If you want to take a stab at moving the existing Katib docs over that would be great.

@amsaha
Copy link
Contributor

amsaha commented Jul 30, 2018

Thanks @sarahmaddox and @jlewi for the comments. I will work on this (thats why I assigned it to myself). So I will put it in Guides->Components->Hyperparameter Tuning.

Wondering whether Katib should be part of the name (Guides->Components->Hyperparameter Tuning (Katib)) so that users who know of Katib (instead of the general area of hyperparameter tuning) can also easily locate the doc.

amsaha added a commit to amsaha/website that referenced this issue Jul 30, 2018
amsaha added a commit to amsaha/website that referenced this issue Jul 30, 2018
k8s-ci-robot pushed a commit that referenced this issue Jul 31, 2018
* Moved pytorch doc from 'About' to 'Getting Started' - issue #82

* moved katib readme from kubeflow/kubeflow. Issue #72

* fixed alphabetical order. Issue #72

* used standard  syntax
@amsaha
Copy link
Contributor

amsaha commented Jul 31, 2018

/close

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants