Katib: Reorganized Katib Docs #3723
Conversation
|
/hold for review |
andreyvelich
force-pushed
the
katib-improve-docs
branch
from
70ba049
to
89da855
Compare
|
This PR should be ready for review. |
andreyvelich
changed the title
| title = "Environment Variables for Katib Components" | ||
| description = "How to set up environment variables for each Katib component" | ||
| title = "How to Configure Environment for Katib Components" | ||
| description = "List of environment variables that accepted by Katib components" |
There was a problem hiding this comment.
| description = "List of environment variables that accepted by Katib components" | |
| description = "List of environment variables accepted by Katib components" |
| - Katib [installed](/docs/components/katib/installation/#installing-katib). | ||
| - Katib Python SDK [installed](/docs/components/katib/installation/#installing-katib-python-sdk). | ||
|
|
||
| ## Getting Started with Katib Python SDK |
There was a problem hiding this comment.
I'm wondering if we can the guide about ## Getting Started with kubectl here as well.
If we can add that, I think that we can move https://github.com/kubeflow/katib/tree/1551ca3975ed50a5af3946bb8847e908888ce27e/examples/v1beta1/kind-cluster to here.
@andreyvelich WDYT?
There was a problem hiding this comment.
That is interesting, but I already added the section about getting started with Experiment YAML.
For me the kind guides relate to Developer guides section since prerequisite for Katib getting started is to install Katib Control Plane.
Eventually, we want to split our docs like this:
- User Guides (how to run Katib Experiments)
- Administrators Guides (how to install and configure Katib ControlPlane)
- Developer Guides (how to contribute and develop Katib platform)
There was a problem hiding this comment.
That is interesting, but I already added the section about getting started with Experiment YAML.
Oh, I was missing the section. So, I'm ok with keeping the current getting started. Thanks!
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
|
@StefanoFioravanzo I made your suggested changes, please let me know what do you think. |
Signed-off-by: Andrey Velichkevich <[email protected]>
|
@andreyvelich so we don't end up with 404 errors (which hurt SEO and confuse users), can you please add redirects for any pages that you have removed/renamed? You need to update this file: https://github.com/kubeflow/website/blob/master/content/en/_redirects |
It's a good point! I will update it. |
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
andreyvelich
force-pushed
the
katib-improve-docs
branch
from
4648e6b
to
817621a
Compare
|
@StefanoFioravanzo Thanks again for your great review! |
| @@ -70,7 +70,6 @@ | |||
| docs/started/requirements/ /docs/started/getting-started/ | |||
|
|
|||
| # Created a new components layout | |||
| /docs/components/hyperparameter /docs/components/katib/overview | |||
There was a problem hiding this comment.
It's usually best to leave the old redirects, as it creates history, and is fine to chain them.
There was a problem hiding this comment.
@thesuperzapper I didn't remove the old redirect, I just moved it below:
Line 238 in 817621a
There was a problem hiding this comment.
@andreyvelich yea, don't do that, as it might break a subsequent redirects that have happened since (if the page has been moved multiple times).
We should only add things to the end of the file. That lets us assume that the current state of the website already has its redirects set up, so we only add new redirects for the actual changes we have made.
|
@andreyvelich thank you for putting so much effort on this. I love how we are refactoring these docs. They will become an example for all other WGs. /lgtm |
Signed-off-by: Andrey Velichkevich <[email protected]>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: andreyvelich 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 |
|
/hold cancel |
|
|
||
| # Refactor Katib docs | ||
| /docs/components/hyperparameter /docs/components/katib/overview | ||
| /docs/components/katib/hyperparameter /docs/components/katib/getting-started.md |
There was a problem hiding this comment.
@andreyvelich this leads to a 404, because you have put /docs/components/katib/getting-started.md (with .md)
There was a problem hiding this comment.
Great catch, I fixed it: #3733
Fixes: kubeflow/katib#2314, kubeflow/katib#1672.
I reorganized Katib doc based on our recent discussions.
Still need to finish some docs:
@StefanoFioravanzo Please let me know what do you think about this doc structure.
/assign @StefanoFioravanzo @droctothorpe @kubeflow/wg-training-leads @hbelmiro @droctothorpe @franciscojavierarceo