wehub-resource-sync
56 lines
2.8 KiB
YAML
56 lines
2.8 KiB
YAML
name: Documentation Fix
|
|
description: Use this template for proposing documentation fixes/improvements.
|
|
labels: "area/docs"
|
|
title: "[DOC-FIX]"
|
|
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
> [!WARNING]
|
|
> Before submitting a PR, please make sure that:
|
|
> - A maintainer has triaged this issue and applied the `ready` label
|
|
> - This issue has no assignee
|
|
> - No duplicate PR exists
|
|
>
|
|
> PRs not meeting these requirements may be automatically closed.
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thank you for submitting an issue. Please refer to our [issue policy](https://www.github.com/mlflow/mlflow/blob/master/ISSUE_POLICY.md) for information on what types of issues we address.
|
|
|
|
**Is this the right repository?**
|
|
- ✅ **Documentation pages** under https://mlflow.org/docs (API reference, tutorials, how-to guides) — you're in the right place!
|
|
- ❌ **Main website content** (blog posts, marketing pages, other site content) — please file at https://github.com/mlflow/mlflow-website/issues instead
|
|
|
|
**Important note about documentation branches:**
|
|
The production documentation at https://mlflow.org/docs/latest/ is built from the **release branch** (e.g., `branch-3.7`), not `master`. If you notice a discrepancy between the live docs and the source code on `master`, the fix may already exist on `master`. You can verify this by checking the preview site at https://dev--mlflow-docs-preview.netlify.app/docs/latest which is built from `master`.
|
|
|
|
**Please fill in this documentation issue template to ensure a timely and thorough response.**
|
|
- type: dropdown
|
|
id: contribution
|
|
attributes:
|
|
label: Willingness to contribute
|
|
description: The MLflow Community encourages documentation fix contributions. Would you or another member of your organization be willing to contribute a fix for this documentation issue to the MLflow code base?
|
|
options:
|
|
- Yes. I can contribute a documentation fix independently.
|
|
- Yes. I would be willing to contribute a document fix with guidance from the MLflow community.
|
|
- No. I cannot contribute a documentation fix at this time.
|
|
validations:
|
|
required: true
|
|
- type: textarea
|
|
attributes:
|
|
label: URL(s) with the issue
|
|
description: |
|
|
Please provide a link to the documentation entry in question.
|
|
Note: This repo is for https://mlflow.org/docs pages only. For other website content, use https://github.com/mlflow/mlflow-website/issues.
|
|
validations:
|
|
required: true
|
|
- type: textarea
|
|
attributes:
|
|
label: Description of proposal (what needs changing)
|
|
description: |
|
|
Provide a clear description. Why is the proposed documentation better?
|
|
validations:
|
|
required: true
|