mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2026-07-15 02:22:50 -04:00
Merge branch 'master' of github.com:squidfunk/mkdocs-material
This commit is contained in:
4
.github/ISSUE_TEMPLATE/01-report-a-bug.yml
vendored
4
.github/ISSUE_TEMPLATE/01-report-a-bug.yml
vendored
@@ -31,7 +31,7 @@ body:
|
||||
description: >-
|
||||
Please list all links to the sections of
|
||||
[our documentation](https://squidfunk.github.io/mkdocs-material) that
|
||||
are relevant to the bug, in order to show that you have consulted and
|
||||
are relevant to the bug in order to show that you have consulted and
|
||||
thoroughly read it. Additionally, list links to possibly related open
|
||||
and closed [issues](https://github.com/squidfunk/mkdocs-material/issues)
|
||||
and [discussions](https://github.com/squidfunk/mkdocs-material/discussions)
|
||||
@@ -54,7 +54,7 @@ body:
|
||||
.zip file with the reproduction. We reserve the right to close issues
|
||||
without .zip files. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#reproduction)
|
||||
placeholder: |-
|
||||
Drag and drop .zip file with minimal reproduction here.
|
||||
Drag and drop the .zip file with minimal reproduction here.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ body:
|
||||
Please describe the inconsistency or issue you have found in
|
||||
[our documentation](https://squidfunk.github.io/mkdocs-material)
|
||||
or indicate where you feel there is a need for improvement. Furthermore,
|
||||
explain the severity of the issue, i.e., it's impact on you and potentially
|
||||
explain the severity of the issue, i.e., its impact on you and potentially
|
||||
other users.
|
||||
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#description)
|
||||
validations:
|
||||
|
||||
14
.github/ISSUE_TEMPLATE/03-request-a-change.yml
vendored
14
.github/ISSUE_TEMPLATE/03-request-a-change.yml
vendored
@@ -17,8 +17,8 @@ body:
|
||||
attributes:
|
||||
label: Description
|
||||
description: >-
|
||||
Please provide a detailed description of your idea in 2-3 sentences, so
|
||||
that we maintainers can fully understand what change, feature, or
|
||||
Please provide a detailed description of your idea in 2-3 sentences so
|
||||
that we maintainers can fully understand what change, feature, or the
|
||||
improvement you are proposing. Don't yet explain the benefits of your
|
||||
idea, we'll come to that. Focus on functionality.
|
||||
[More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#description)
|
||||
@@ -31,7 +31,7 @@ body:
|
||||
label: Related links
|
||||
description: >-
|
||||
Please list all links to open and closed [issues](https://github.com/squidfunk/mkdocs-material/issues),
|
||||
[discussions](https://github.com/squidfunk/mkdocs-material/discussions)
|
||||
[discussions](https://github.com/squidfunk/mkdocs-material/discussions),
|
||||
or to [documentation sections](https://squidfunk.github.io/mkdocs-material)
|
||||
that are relevant to your idea.
|
||||
If you discussed your idea with the community on our
|
||||
@@ -50,8 +50,8 @@ body:
|
||||
label: Use Cases
|
||||
description: >-
|
||||
Please explain how your idea will work from an author's and user's
|
||||
perspective. Elaborate how the change would positively impact not only
|
||||
you, but the community, and how it aligns with the goals and [philopsophy](https://squidfunk.github.io/mkdocs-material/philosophy/)
|
||||
perspective. Elaborate on how the change would positively impact not only
|
||||
you but the community and how it aligns with the goals and [philosophy](https://squidfunk.github.io/mkdocs-material/philosophy/)
|
||||
of the project.
|
||||
[More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#use-cases)
|
||||
validations:
|
||||
@@ -87,9 +87,9 @@ body:
|
||||
I have verified that [my idea is a change request and not a bug report](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#its-not-a-bug-its-a-feature).
|
||||
required: true
|
||||
- label: >-
|
||||
I have ensured that, to the best knowledge, [my idea will benefit the entire community](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#benefit-for-the-community).
|
||||
I have ensured that, to the best of my knowledge, [my idea will benefit the entire community](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#benefit-for-the-community).
|
||||
required: true
|
||||
- label: >-
|
||||
I have included relevant links to [the documentation](https://squidfunk.github.io/mkdocs-material), related [issues](https://github.com/squidfunk/mkdocs-material/issues)
|
||||
I have included relevant links to [the documentation](https://squidfunk.github.io/mkdocs-material), related [issues](https://github.com/squidfunk/mkdocs-material/issues),
|
||||
and [discussions](https://github.com/squidfunk/mkdocs-material/discussions) to underline the need for my idea.
|
||||
required: true
|
||||
|
||||
@@ -17,7 +17,7 @@ body:
|
||||
id: translations
|
||||
attributes:
|
||||
label: Translations
|
||||
description: Please translate the labels on the right, e.g. "Copy to clipboard", etc.
|
||||
description: Please translate the labels on the right, e.g., "Copy to clipboard", etc.
|
||||
value: |-
|
||||
{% macro t(key) %}{{ {
|
||||
"language": "en",
|
||||
@@ -73,7 +73,7 @@ body:
|
||||
options:
|
||||
- label: I've checked the list of [available languages](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language) for existing translations.
|
||||
required: true
|
||||
- label: I assure that the translations are accurate to my best knowledge.
|
||||
- label: I assure that the translations are accurate to the best of my knowledge.
|
||||
required: true
|
||||
- label: >-
|
||||
__Optional__: I want to integrate this translation myself and create a
|
||||
|
||||
Reference in New Issue
Block a user