Edit Docusaurus README.mds #14325

daniellok-db · 2025-01-24T07:41:02Z

🛠 DevTools 🛠

Install mlflow from this PR

# Use `%sh` to run this command on Databricks
OPTIONS=$(if pip freeze | grep -q 'mlflow @ git+https://github.com/mlflow/mlflow.git'; then echo '--force-reinstall --no-deps'; fi)
pip install $OPTIONS git+https://github.com/mlflow/mlflow.git@refs/pull/14325/merge

Checkout with GitHub CLI

gh pr checkout 14325

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

This PR adds instructions for building the new Docusaurus docs!

How is this PR tested?

Existing unit/integration tests
New unit/integration tests
Manual tests

Does this PR require documentation update?

Release Notes

Is this a user-facing change?

No. You can skip the rest of this section.
Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

Interface

area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
area/windows: Windows support

Language

language/r: R APIs and clients
language/java: Java APIs and clients
language/new: Proposals for new client languages

Integrations

integrations/azure: Azure and Azure ML integrations
integrations/sagemaker: SageMaker integrations
integrations/databricks: Databricks integrations

How 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" section
rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
rn/feature - A new user-facing feature worth mentioning in the release notes
rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should 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?

Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
Bug fixes, doc updates and new features usually go into minor releases.
Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
Bug fixes and doc updates usually go into patch releases.

Yes (this PR will be cherry-picked and included in the next patch release)
No (this PR will be included in the next minor release)

github-actions · 2025-01-24T07:41:35Z

Documentation preview for f5f6eed will be available when this CircleCI job
completes successfully. You may encounter a {"message":"not found"} error when reloading
a page. If so, add /index.html to the URL.

More info

Ignore this comment if this PR does not change the documentation.
It takes a few minutes for the preview to be available.
The preview is updated when a new commit is pushed to this PR.
This comment was created by https://github.com/mlflow/mlflow/actions/runs/12983251516.

daniellok-db · 2025-01-24T08:03:03Z

.circleci/config.yml

@@ -78,6 +78,7 @@ jobs:
          command: |
            yarn install
            yarn build-api-docs:no-r
+            yarn update-api-modules


missed this in CI update

daniellok-db · 2025-01-24T08:04:25Z

CONTRIBUTING.md

@@ -831,87 +831,24 @@ We use [taplo](https://taplo.tamasfe.dev/) to enforce consistent TOML formatting

 ### Writing Docs

-First, install dependencies for building docs as described in [Environment Setup and Python configuration](#environment-setup-and-python-configuration).


old docs guide moved from CONTRIBUTING.md -> docs/api_reference/README.md. since editing the API docs basically involves editing docstrings (and requires python + doc dependencies etc), i want to focus more on the main docs in this section.

docs/README.md

TomeHirata · 2025-01-24T08:57:39Z

docs/README.md

-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+1. Run `yarn build-api-docs` in order to build the API reference and copy the generated HTML to `static/api_reference`.


Can we combine them into a single make task?

done! combined them into yarn build-api-docs

docs/api_reference/README.md

docs/README.md

harupy · 2025-01-27T06:15:16Z

docs/README.md

+  a. To speed up the build locally, you can run `yarn build-api-docs:no-r` to skip building R documentation
+2. Run `yarn convert-notebooks` to convert `.ipynb` files to `.mdx` files. The generated files are git-ignored.
+3. **⚠️ Important!** Run `export DOCS_BASE_URL=/docs/latest` (or wherever the docs are expected to be served). This configures the [Docusaurus baseUrl](https://docusaurus.io/docs/api/docusaurus-config#baseUrl), and the site may not render correctly if this is improperly set.
+4. Finally, run `yarn build`. This generates static files in the `build` directory, which can then be served.


Can we also add yarn serve as an optional step? This command allows testing prod-only features such as redirect.

docs/README.md

harupy · 2025-01-27T06:17:38Z

docs/README.md

-```
-$ USE_SSH=true yarn deploy
-```
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.


Let's add a note here saying some features might be disabled in this mode.

Example: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-client-redirects

Signed-off-by: Daniel Lok <[email protected]>

harupy

Left some comments, otherwise LGTM!

Signed-off-by: Daniel Lok <[email protected]>

Signed-off-by: Daniel Lok <[email protected]> Signed-off-by: k99kurella <[email protected]>

github-actions bot added the rn/none List under Small Changes in Changelogs. label Jan 24, 2025

daniellok-db commented Jan 24, 2025

View reviewed changes

daniellok-db requested a review from mlflow-automation January 24, 2025 08:08

github-actions bot requested review from B-Step62, BenWilson2, harupy, serena-ruan, TomeHirata, WeichenXu123 and xq-yin and removed request for mlflow-automation January 24, 2025 08:08

TomeHirata reviewed Jan 24, 2025

View reviewed changes

docs/README.md Outdated Show resolved Hide resolved

TomeHirata reviewed Jan 24, 2025

View reviewed changes

harupy reviewed Jan 27, 2025

View reviewed changes

docs/api_reference/README.md Show resolved Hide resolved

harupy reviewed Jan 27, 2025

View reviewed changes

docs/README.md Show resolved Hide resolved

harupy reviewed Jan 27, 2025

View reviewed changes

daniellok-db commented Jan 27, 2025

View reviewed changes

docs/README.md Show resolved Hide resolved

harupy reviewed Jan 27, 2025

View reviewed changes

daniellok-db added 8 commits January 27, 2025 14:21

readme

b6a2705

Signed-off-by: Daniel Lok <[email protected]>

fix

d6fb862

Signed-off-by: Daniel Lok <[email protected]>

fix

e8f3b7b

Signed-off-by: Daniel Lok <[email protected]>

fix

2683cf8

Signed-off-by: Daniel Lok <[email protected]>

fix

0aa06e5

Signed-off-by: Daniel Lok <[email protected]>

fix

936e320

Signed-off-by: Daniel Lok <[email protected]>

comments

73b25fd

Signed-off-by: Daniel Lok <[email protected]>

ci

72ecf67

Signed-off-by: Daniel Lok <[email protected]>

harupy approved these changes Jan 27, 2025

View reviewed changes

comment

f5f6eed

Signed-off-by: Daniel Lok <[email protected]>

daniellok-db force-pushed the daniellok-db/readmes branch from f931e90 to f5f6eed Compare January 27, 2025 06:25

daniellok-db enabled auto-merge January 27, 2025 06:54

daniellok-db disabled auto-merge January 27, 2025 07:18

daniellok-db merged commit ced74a9 into mlflow:master Jan 27, 2025
40 of 42 checks passed

karthikkurella pushed a commit to karthikkurella/mlflow that referenced this pull request Jan 30, 2025

Edit Docusaurus README.mds (mlflow#14325)

4e85172

Signed-off-by: Daniel Lok <[email protected]> Signed-off-by: k99kurella <[email protected]>

karthikkurella pushed a commit to karthikkurella/mlflow that referenced this pull request Jan 30, 2025

Edit Docusaurus README.mds (mlflow#14325)

3f9ba04

Signed-off-by: Daniel Lok <[email protected]> Signed-off-by: k99kurella <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Edit Docusaurus README.mds #14325

Edit Docusaurus README.mds #14325

daniellok-db commented Jan 24, 2025 •

edited by github-actions bot

Loading

github-actions bot commented Jan 24, 2025 •

edited

Loading

daniellok-db Jan 24, 2025

daniellok-db Jan 24, 2025

TomeHirata Jan 24, 2025

daniellok-db Jan 27, 2025

harupy Jan 27, 2025 •

edited

Loading

harupy Jan 27, 2025

harupy left a comment

		@@ -831,87 +831,24 @@ We use [taplo](https://taplo.tamasfe.dev/) to enforce consistent TOML formatting

		### Writing Docs

		First, install dependencies for building docs as described in [Environment Setup and Python configuration](#environment-setup-and-python-configuration).

Edit Docusaurus README.mds #14325

Edit Docusaurus README.mds #14325

Conversation

daniellok-db commented Jan 24, 2025 • edited by github-actions bot Loading

Install mlflow from this PR

Checkout with GitHub CLI

Related Issues/PRs

What 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?

How should the PR be classified in the release notes? Choose one:

Should this PR be included in the next patch release?

github-actions bot commented Jan 24, 2025 • edited Loading

daniellok-db Jan 24, 2025

Choose a reason for hiding this comment

daniellok-db Jan 24, 2025

Choose a reason for hiding this comment

TomeHirata Jan 24, 2025

Choose a reason for hiding this comment

daniellok-db Jan 27, 2025

Choose a reason for hiding this comment

harupy Jan 27, 2025 • edited Loading

Choose a reason for hiding this comment

harupy Jan 27, 2025

Choose a reason for hiding this comment

harupy left a comment

Choose a reason for hiding this comment

daniellok-db commented Jan 24, 2025 •

edited by github-actions bot

Loading

github-actions bot commented Jan 24, 2025 •

edited

Loading

harupy Jan 27, 2025 •

edited

Loading