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

Katib: Reorganized Katib Docs #3723

Merged
merged 21 commits into from
May 8, 2024
Merged
Show file tree
Hide file tree
Changes from 20 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion content/en/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@
docs/started/requirements/ /docs/started/getting-started/

# Created a new components layout
/docs/components/hyperparameter /docs/components/katib/overview
Copy link
Member

Choose a reason for hiding this comment

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

It's usually best to leave the old redirects, as it creates history, and is fine to chain them.

Copy link
Member Author

Choose a reason for hiding this comment

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

@thesuperzapper I didn't remove the old redirect, I just moved it below:

/docs/components/hyperparameter /docs/components/katib/overview

Copy link
Member

Choose a reason for hiding this comment

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

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

/docs/components/chainer /docs/components/training/chainer
/docs/components/modeldb /docs/components/misc/modeldb
/docs/components/mpi /docs/components/training/mpi
Expand Down Expand Up @@ -234,3 +233,11 @@ docs/started/requirements/ /docs/started/getting-started/
/docs/distributions/gke/* https://googlecloudplatform.github.io/kubeflow-gke-docs/docs/:splat
/docs/distributions/ibm/* https://ibm.github.io/manifests/
/docs/distributions/nutanix/* https://nutanix.github.io/kubeflow-manifests/

# Refactor Katib docs
/docs/components/hyperparameter /docs/components/katib/overview
/docs/components/katib/hyperparameter /docs/components/katib/getting-started.md
Copy link
Member

Choose a reason for hiding this comment

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

@andreyvelich this leads to a 404, because you have put /docs/components/katib/getting-started.md (with .md)

Copy link
Member Author

Choose a reason for hiding this comment

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

Great catch, I fixed it: #3733

/docs/components/katib/experiment /docs/components/katib/user-guides/hp-tuning/configure-experiment
/docs/components/katib/early-stopping /docs/components/katib/user-guides/early-stopping
/docs/components/katib/resume-experiment /docs/components/katib/user-guides/resume-experiment
/docs/components/katib/trial-template /docs/components/katib/user-guides/trial-template
208 changes: 0 additions & 208 deletions content/en/docs/components/katib/early-stopping.md

This file was deleted.

Loading