Skip to content

Add note about documentation branches to doc fix issue template#19264

Merged
harupy merged 1 commit intomlflow:masterfrom
harupy:add-doc-branch-note-to-issue-template
Dec 8, 2025
Merged

Add note about documentation branches to doc fix issue template#19264
harupy merged 1 commit intomlflow:masterfrom
harupy:add-doc-branch-note-to-issue-template

Conversation

@harupy
Copy link
Member

@harupy harupy commented Dec 8, 2025

Related Issues/PRs

#19256

What changes are proposed in this pull request?

Add a note to the documentation fix issue template clarifying that:

This helps reporters and maintainers quickly identify whether an issue is a missing backport vs. a genuine bug.

How is this PR tested?

  • Manual tests

Does this PR require documentation update?

  • No. You can skip the rest of this section.

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.

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

Components

  • area/build: Build and test infrastructure for MLflow

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

Should this PR be included in the next patch release?

  • 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)

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings December 8, 2025 02:07
@github-actions
Copy link
Contributor

github-actions bot commented Dec 8, 2025

@harupy Thank you for the contribution! Could you fix the following issue(s)?

⚠ Invalid PR template

This PR does not appear to have been filed using the MLflow PR template. Please copy the PR template from here and fill it out.

@harupy harupy force-pushed the add-doc-branch-note-to-issue-template branch from be9d769 to 2c0e760 Compare December 8, 2025 02:08
Clarify that production docs are built from release branches, not master,
and provide the preview site URL for verification.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
@harupy harupy force-pushed the add-doc-branch-note-to-issue-template branch from 2c0e760 to 05720ec Compare December 8, 2025 02:08
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 enhances the documentation fix issue template by adding clarification about the documentation build process and branch structure. This helps issue reporters and maintainers distinguish between genuine documentation bugs and cases where fixes exist on master but haven't been backported to release branches.

Key Changes:

  • Added informational note explaining that production docs are built from release branches (e.g., branch-3.7), not master
  • Included reference to the preview site for verifying whether fixes already exist on master

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions github-actions bot added v3.7.1 area/build Build and test infrastructure for MLflow rn/none List under Small Changes in Changelogs. labels Dec 8, 2025
@harupy harupy added team-review Trigger a team review request and removed v3.7.1 labels Dec 8, 2025
Copy link
Collaborator

@serena-ruan serena-ruan left a comment

Choose a reason for hiding this comment

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

LGTM!

@harupy harupy added this pull request to the merge queue Dec 8, 2025
Merged via the queue into mlflow:master with commit 7988182 Dec 8, 2025
57 of 61 checks passed
@harupy harupy deleted the add-doc-branch-note-to-issue-template branch December 8, 2025 06:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/build Build and test infrastructure for MLflow rn/none List under Small Changes in Changelogs. team-review Trigger a team review request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants