You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Simplify the overview page by moving the architecture part to "Reference"
Add an "Installation" page (move it out form the "Getting Started")
"Getting Started": Pick one example (the most iconic one) from the current Getting Started page and put it on top. Organize the other examples in subpages or a "Tutorials" section
Move "Accessing the Katib UI" from Getting Started to its own user guide page.
Move "Running an Experiment", to a "User Guides" section
Simplify "Running an Experiment" by moving the architectural details and explanation of the search arlgorithms to "Reference"
Move "Resuming an Experiment" to "User Guides"
Move "Overview of Trial Templates" to "Reference"
Move "Using Early Stopping" to "User Guides"
Consider splitting "Katib Configuration overview" into a reference guide for arch/api details and a user guide with an how-to
Move "Environment Variables for Katib Components" under "Reference".
New content:
Move contributor guide from GH to Website
TBD
cc @kubeflow/wg-automl-leads
The text was updated successfully, but these errors were encountered:
Thank you for this @StefanoFioravanzo! @tenzen-y Do you think it make sense to store developer guides in the GitHub rather than website ?
In the future, we can split the Website section between these personas: User Guides, Administrators Guides, Developer Guides.
Like in Jupyter: https://jupyter-server.readthedocs.io/en/latest/ or KServe docs: https://kserve.github.io/website/0.10/get_started/.
So all of the docs will be in the single place.
We can always create CONTRIBUTING.md file in Katib and Training Operator repo to re-direct developers to Kubeflow website.
About your message: this repository is an actual working space for developers. That is fair, but to understand Katib source code and features, developers have to read the kubeflow.org.
What do you think ?
Maybe we can store only proposals in our GitHub repos given that we have most of the docs on Kubeflow Website ?
This is a tracking issue for documentation enhancements for Katib 0.17
Restructuring proposal: (this is purely moving content around to have a better docs UX - see below for content improvements)
I propose restructuring the existing guides in the same spirit of what I wrote here kubeflow/training-operator#1998 (comment).
Proposal:
New content:
cc @kubeflow/wg-automl-leads
The text was updated successfully, but these errors were encountered: