Skip to content

Conversation

@harupy
Copy link
Member

@harupy harupy commented Jun 25, 2025

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/16434/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/16434/merge#subdirectory=skinny

For Databricks, use the following command:

%sh curl -LsSf https://raw.githubusercontent.com/mlflow/mlflow/HEAD/dev/install-skinny.sh | sh -s pull/16434/merge

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

This PR removes two sections from GenAI documentation that contained broken links:

  1. key-challenges.mdx: Removed the "Next Steps" section that included a broken link to /genai/overview/how-mlflow-helps
  2. why-mlflow.mdx: Removed the "Ready to Build Better GenAI Applications?" section that included a broken link to /genai/tutorials

These sections were determined to be non-essential and were causing documentation issues due to the broken links.

How is this PR tested?

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

The changes were verified by checking that the documentation builds correctly and the broken links are no longer present.

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

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

  • area/artifacts: Artifact stores and artifact logging
  • area/build: Build and test infrastructure for MLflow
  • area/deployments: MLflow Deployments client APIs, server, and third-party Deployments integrations
  • area/docs: MLflow documentation pages
  • area/examples: Example code
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/projects: MLproject format, project running backends
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/server-infra: MLflow Tracking server backend
  • area/tracking: Tracking Service, tracking client APIs, autologging

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)

- Remove 'Next Steps' section from key-challenges.mdx with broken link to /genai/overview/how-mlflow-helps
- Remove 'Ready to Build Better GenAI Applications?' section from why-mlflow.mdx with broken link to /genai/tutorials
- These sections contained broken links that are not necessary for the documentation

Signed-off-by: harupy <[email protected]>
Copilot AI review requested due to automatic review settings June 25, 2025 00:50
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR removes two non-essential documentation sections containing broken links to improve build stability and user experience.

  • Deleted the "Ready to Build Better GenAI Applications?" section from why-mlflow.mdx
  • Deleted the "Next Steps" section from key-challenges.mdx

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/docs/genai/overview/why-mlflow.mdx Removed the broken “Ready to Build Better GenAI Applications?” section
docs/docs/genai/overview/key-challenges.mdx Removed the broken “Next Steps” section

@github-actions github-actions bot added area/docs Documentation issues rn/none List under Small Changes in Changelogs. v3.1.1 labels Jun 25, 2025
@github-actions
Copy link
Contributor

Documentation preview for e27125d 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

@harupy harupy enabled auto-merge June 25, 2025 01:01
@harupy harupy disabled auto-merge June 25, 2025 01:32
@harupy harupy merged commit c627f21 into mlflow:master Jun 25, 2025
46 of 51 checks passed
@harupy harupy deleted the fix-broken-links-in-genai-docs branch June 25, 2025 01:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation issues rn/none List under Small Changes in Changelogs. v3.1.1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants