[Doc] Re-organize sidebar sections#18950
Conversation
Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
|
Documentation preview for ae491d6 is available at: Changed Pages (8)
More info
|
| id: 'flavors/index', | ||
| }, | ||
| }, | ||
| { |
There was a problem hiding this comment.
Thoughts on updating Model Serving category to Agent Serving?
There was a problem hiding this comment.
I love the idea, do we need wider refactoring of the docs & apis to make things consistent?
+1, it renders a bit too big in my Mac screen (does not fit to single scroll). |
|
sure, will reduce the font size and spacing. |
Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
|
@serena-ruan new commit brought back the previous font size and reduce the vertical spacing. The ML doc indentation issue is also fixed. |
Thanks! While I still think the space between each section is big: e.g. between 'overview' and 'Getting started'. Could we still use the old layout but only make each section title bold? |
Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
|
@serena-ruan great feedback! fixed in the latest commit and it looks much better now. |




🛠 DevTools 🛠
Install mlflow from this PR
For Databricks, use the following command:
Re-organize sidebar sections based on reading priority. The goal is to make sure users, especially if they are new, don't get lost when going through the "table of content". And users should be able to understand what are the minimal set of docs they need to read based on the new section structure.
Couple of things that are somewhat related in this PR:
Related Issues/PRs
#xxxWhat changes are proposed in this pull request?
How is this PR tested?
Does this PR require documentation update?
Release Notes
Is this a user-facing change?
What component(s), interfaces, languages, and integrations does this PR affect?
Components
area/tracking: Tracking Service, tracking client APIs, autologgingarea/models: MLmodel format, model serialization/deserialization, flavorsarea/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registryarea/scoring: MLflow Model server, model deployment tools, Spark UDFsarea/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflowsarea/gateway: MLflow AI Gateway client APIs, server, and third-party integrationsarea/prompts: MLflow prompt engineering features, prompt templates, and prompt managementarea/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionalityarea/projects: MLproject format, project running backendsarea/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev serverarea/build: Build and test infrastructure for MLflowarea/docs: MLflow documentation pagesHow should the PR be classified in the release notes? Choose one:
rn/none- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionrn/breaking-change- The PR will be mentioned in the "Breaking Changes" sectionrn/feature- A new user-facing feature worth mentioning in the release notesrn/bug-fix- A user-facing bug fix worth mentioning in the release notesrn/documentation- A user-facing documentation change worth mentioning in the release notesShould this PR be included in the next patch release?
Yesshould be selected for bug fixes, documentation updates, and other small changes.Noshould be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.What is a minor/patch release?
Bug fixes, doc updates and new features usually go into minor releases.
Bug fixes and doc updates usually go into patch releases.