Katib: Reorganized Katib Docs

[andreyvelich]

Fixes: https://github.com/kubeflow/katib/issues/2314, https://github.com/kubeflow/katib/issues/1672.

I reorganized Katib doc based on our recent discussions.

Still need to finish some docs:

• Add Why Katib? sections.
• Add AI/ML Lifecycle Diagram.

@StefanoFioravanzo Please let me know what do you think about this doc structure.

/assign @StefanoFioravanzo @droctothorpe @kubeflow/wg-training-leads @hbelmiro @droctothorpe @franciscojavierarceo

[andreyvelich]

/hold for review

[andreyvelich]

This PR should be ready for review. @StefanoFioravanzo @hbelmiro @kubeflow/wg-training-leads Please let me know what do you think about new doc structure?

[tenzen-y]

/lgtm

[andreyvelich]

/assign @StefanoFioravanzo Any feedback from your side ?

[andreyvelich]

Are there any new how-to guides or did you just move them without changes?

Yes, I added a few new docs from Katib GitHub:

1. Added section "How to add custom HP tuning algorithm": from this GitHub doc.
2. Added NAS algorithm references from DARTS and ENAS.

I think, our goal should be to keep all docs (users, admins, and developers) in the single place. What do you think about it @kubeflow/wg-training-leads ? In the future, we can try to organize kubeflow.org to fetch doc files from the GitHub repos as we thought before, but it will take time to discuss/implement it.

[andreyvelich]

@StefanoFioravanzo I made your suggested changes, please let me know what do you think.

[thesuperzapper]

@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

[andreyvelich]

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

[andreyvelich]

@StefanoFioravanzo Thanks again for your great review! Do you have any other suggestions for this PR ?

[StefanoFioravanzo]

@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

[google-oss-prow[bot]]

[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: - ~~[OWNERS](https://github.com/kubeflow/website/blob/master/OWNERS)~~ [andreyvelich] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment

[andreyvelich]

/hold cancel