mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Switched templates to GitHub's Issue forms (#2790)
* Switch to yaml issue form * fix validations typo * use a header? * Transform feature.md to feature.yml * Update bug.yml * transform translate.md to translate.yml * Update translate.yml
This commit is contained in:
Andre_601
GitHub
parent
9b3c59ebaf
commit
0de370d37d
77
.github/ISSUE_TEMPLATE/bug.md
vendored
77
.github/ISSUE_TEMPLATE/bug.md
vendored
@ -1,77 +0,0 @@
|
||||
---
|
||||
name: Bug
|
||||
about: Report a bug
|
||||
title: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
<!--
|
||||
⚠️ WARNING
|
||||
|
||||
Half of all issues created do not contain enough information to help or are
|
||||
not appropriate for the issue tracker (i.e. one-line questions). If you think
|
||||
you found a bug, follow the steps outlined below closely. Any issue that does
|
||||
not meet these conditions may be closed unnoticed.
|
||||
|
||||
Why? Because the maintainers of this project are wasting a lot of time
|
||||
answering questions that are not directly related to this project. If you
|
||||
have a question, please ask your question over in "Discussions", so other
|
||||
users can help you work towards a solution.
|
||||
|
||||
Make sure that your request fulfills ALL of the following requirements. If one
|
||||
requirement cannot be satisfied, please explain in detail why.
|
||||
-->
|
||||
|
||||
- [ ] I've read the [contribution guidelines][1] and agree with them
|
||||
|
||||
__I've found a bug and checked that ...__
|
||||
|
||||
- [ ] ... the problem doesn't occur with the default MkDocs template
|
||||
- [ ] ... the problem is not in any of my customizations (CSS, JS, template)
|
||||
- [ ] ... the documentation does not mention anything about my problem
|
||||
- [ ] ... there are no open or closed issues that are related to my problem
|
||||
|
||||
## Description
|
||||
|
||||
<!-- Please provide a brief description of the bug -->
|
||||
|
||||
### Expected behavior
|
||||
|
||||
<!-- Please describe what you expect to happen -->
|
||||
|
||||
### Actual behavior
|
||||
|
||||
<!-- Please describe what is actually happening -->
|
||||
|
||||
### Steps to reproduce the bug
|
||||
|
||||
<!-- Please provide the steps to reproduce the issue -->
|
||||
|
||||
1. ...
|
||||
2. ...
|
||||
3. ...
|
||||
|
||||
### Package versions
|
||||
|
||||
<!-- Please provide all package versions -->
|
||||
|
||||
* Python: `python --version`
|
||||
* MkDocs: `mkdocs --version`
|
||||
* Material: `pip show mkdocs-material | grep -E ^Version`
|
||||
|
||||
### Project configuration
|
||||
|
||||
<!-- Please provide your mkdocs.yml to a reasonable amount of detail -->
|
||||
|
||||
``` yaml
|
||||
The contents of your mkdocs.yml
|
||||
```
|
||||
|
||||
### System information
|
||||
|
||||
<!-- Please provide your operating system and browser version -->
|
||||
|
||||
* OS: ...
|
||||
* Browser: ...
|
||||
|
||||
[1]: https://github.com/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md
|
||||
95
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
95
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
@ -0,0 +1,95 @@
|
||||
name: Bug Report
|
||||
description: Report a bug
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |-
|
||||
### ⚠️ WARNING
|
||||
|
||||
Half of all issues created do not contain enough to help or are not appropriate for the issue tracker (i.e. one-line questions).
|
||||
If you think you found a bug, follow the steps outlined below closely.
|
||||
Any issue that does not meet these conditions may be closed unnoticed.
|
||||
|
||||
Why? Because the maintainers of this project are wasting a lot of time answering questions that are not directly related to this project.
|
||||
If you have a question, please ask your question over in [Discussions](https://github.com/squidfunk/mkdocs-material/discussions), so other users can help you work towards a solution.
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Read and understand the Contributing guidelines
|
||||
description: You need to have read the contributing guidelines in order to proceed.
|
||||
options:
|
||||
- label: I've read the [contribution Guidelines](https://github.com/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md) and agree with them
|
||||
required: true
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: I've found a bug and checked that ...
|
||||
description: Make sure that your request fulfills ALL of the following requirements. If one requirement cannot be satisfied, please explain in detail why.
|
||||
options:
|
||||
- label: ... the problem doesn't occur with the default MkDocs template
|
||||
- label: ... the problem is not in any of my customizations (CSS, JS, template)
|
||||
- label: ... the documentation does not mention anything about my problem
|
||||
- label: ... there are no open or closed issues that are related to my problem.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Description
|
||||
description: Please provide a breif description of the bug.
|
||||
placeholder: Material for MkDocs does ...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected behaviour
|
||||
description: Please describe what you expect to happen.
|
||||
placeholder: Material for MkDocs should...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Actual Behaviour
|
||||
description: Please describe what is actually happening.
|
||||
placeholder: Material for MkDocs instead does ...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Please provide the steps to reproduce the issue.
|
||||
placeholder: |-
|
||||
1. ...
|
||||
2. ...
|
||||
3. ...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Package versions
|
||||
description: |-
|
||||
Please provide all required package versions.
|
||||
|
||||
- For Python, run `python --version`
|
||||
- For MkDocs, run `mkdocs --version`
|
||||
- For Material for MkDocs, run `pip show mkdocs-material | grep -E ^Version`
|
||||
value: |-
|
||||
- Python: `<python version>`
|
||||
- MkDocs: `<mkdocs version>`
|
||||
- Material: `<material version>`
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Configuration
|
||||
description: Please provide your mkdocs.yml to a reasonable amount of detail.
|
||||
placeholder: |-
|
||||
site_name: My Docs
|
||||
site_url: https://example.com/docs
|
||||
render: yaml
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: System information
|
||||
description: Please provide your operating system and browser type and version.
|
||||
value: |-
|
||||
- OS: `<operating system>`
|
||||
- Browser: `<browser version>`
|
||||
validations:
|
||||
required: true
|
||||
45
.github/ISSUE_TEMPLATE/feature.md
vendored
45
.github/ISSUE_TEMPLATE/feature.md
vendored
@ -1,45 +0,0 @@
|
||||
---
|
||||
name: Feature
|
||||
about: Suggest an idea
|
||||
title: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
<!--
|
||||
⚠️ WARNING
|
||||
|
||||
Half of all issues created do not contain enough information to help or are
|
||||
not appropriate for the issue tracker (i.e. one-line questions). If you would
|
||||
like to suggest a feature, follow the steps outlined below closely. Any issue
|
||||
that does not meet these conditions may be closed unnoticed.
|
||||
|
||||
Why? Because the maintainers of this project are wasting a lot of time
|
||||
answering questions that are not directly related to this project. If you
|
||||
have a question, please ask your question over in "Discussions", so other
|
||||
users can help you work towards a solution.
|
||||
|
||||
Make sure that your request fulfills ALL of the following requirements. If one
|
||||
requirement cannot be satisfied, please explain in detail why.
|
||||
-->
|
||||
|
||||
- [ ] I've read the [contribution guidelines][1] and agree with them
|
||||
|
||||
__I want to suggest an idea and checked that ...__
|
||||
|
||||
- [ ] ... to my best knowledge, my idea wouldn't break something for other users
|
||||
- [ ] ... the documentation does not mention anything about my idea
|
||||
- [ ] ... there are no open or closed issues that are related to my idea
|
||||
|
||||
## Description
|
||||
|
||||
<!-- Please provide a brief description of the feature -->
|
||||
|
||||
### Use Cases
|
||||
|
||||
<!-- Please describe how your suggestion would benefit you and other users -->
|
||||
|
||||
### Screenshots / Mockups
|
||||
|
||||
<!-- If applicable, provide some mockups or screenshots -->
|
||||
|
||||
[1]: https://github.com/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md
|
||||
48
.github/ISSUE_TEMPLATE/feature.yml
vendored
Normal file
48
.github/ISSUE_TEMPLATE/feature.yml
vendored
Normal file
@ -0,0 +1,48 @@
|
||||
name: Feature
|
||||
description: Suggest an idea
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |-
|
||||
### ⚠️ WARNING
|
||||
|
||||
Half of all issues created do not contain enough to help or are not appropriate for the issue tracker (i.e. one-line questions).
|
||||
If you would like to suggest a feature, follow the steps outlined below closely.
|
||||
Any issue that does not meet these conditions may be closed unnoticed.
|
||||
|
||||
Why? Because the maintainers of this project are wasting a lot of time answering questions that are not directly related to this project.
|
||||
If you have a question, please ask your question over in [Discussions](https://github.com/squidfunk/mkdocs-material/discussions), so other users can help you work towards a solution.
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Read and understand the Contributing guidelines
|
||||
description: You need to have read the contributing guidelines in order to proceed.
|
||||
options:
|
||||
- label: I've read the [contribution Guidelines](https://github.com/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md) and agree with them
|
||||
required: true
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: I want to suggest an idea and checked that ...
|
||||
description: Make sure that your request fulfills ALL of the following requirements. If one requirement cannot be satisfied, please explain in detail why.
|
||||
options:
|
||||
- label: ... to my best knowledge, my idea wouldn't break something for other users
|
||||
- label: ... the documentation does not mention anything about my idea
|
||||
- label: ... there are no open or closed issues that are related to my idea
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Description
|
||||
description: Please provide a breif description of the bug.
|
||||
placeholder: My feature would ...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Use Cases
|
||||
description: Please describe how your suggestion would benefit you and other users.
|
||||
placeholder: My feature is beneficial because ...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Screenshots / Mockups
|
||||
description: If applicable, provide some mockups or screenshots.
|
||||
placeholder: "https://i.imgur.com/cat.jpg"
|
||||
53
.github/ISSUE_TEMPLATE/translate.md
vendored
53
.github/ISSUE_TEMPLATE/translate.md
vendored
@ -1,53 +0,0 @@
|
||||
---
|
||||
name: Translate
|
||||
about: 'Help translate Material into more languages '
|
||||
title: 'New translation: {Insert language}'
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Instructions
|
||||
|
||||
1. Check, if your language is already available: [here](https://bit.ly/33vFDD0)
|
||||
2. If it isn't, please translate the labels on the right:
|
||||
|
||||
``` jinja
|
||||
{% macro t(key) %}{{ {
|
||||
"language": "en",
|
||||
"direction": "ltr",
|
||||
"clipboard.copy": "Copy to clipboard",
|
||||
"clipboard.copied": "Copied to clipboard",
|
||||
"edit.link.title": "Edit this page",
|
||||
"footer.previous": "Previous",
|
||||
"footer.next": "Next",
|
||||
"footer.title": "Footer",
|
||||
"header.title": "Header",
|
||||
"meta.comments": "Comments",
|
||||
"meta.source": "Source",
|
||||
"nav.title": "Navigation",
|
||||
"search.config.lang": "en",
|
||||
"search.config.pipeline": "trimmer, stopWordFilter",
|
||||
"search.config.separator": "[\s\-]+",
|
||||
"search.placeholder": "Search",
|
||||
"search.reset": "Clear",
|
||||
"search.result.initializer": "Initializing search",
|
||||
"search.result.placeholder": "Type to start searching",
|
||||
"search.result.none": "No matching documents",
|
||||
"search.result.one": "1 matching document",
|
||||
"search.result.other": "# matching documents",
|
||||
"search.result.more.one": "1 more on this page",
|
||||
"search.result.more.other": "# more on this page",
|
||||
"search.result.term.missing": "Missing",
|
||||
"select.language.title": "Select language",
|
||||
"select.version.title": "Select version",
|
||||
"skip.link.title": "Skip to content",
|
||||
"source.link.title": "Go to repository",
|
||||
"source.file.date.updated": "Last update",
|
||||
"source.file.date.created": "Created",
|
||||
"tabs.title": "Tabs",
|
||||
"toc.title": "Table of contents",
|
||||
"top.title": "Back to top"
|
||||
}[key] }}{% endmacro %}
|
||||
```
|
||||
|
||||
<!-- Thanks you! You've made Material for MkDocs even better! -->
|
||||
64
.github/ISSUE_TEMPLATE/translate.yml
vendored
Normal file
64
.github/ISSUE_TEMPLATE/translate.yml
vendored
Normal file
@ -0,0 +1,64 @@
|
||||
name: Translate
|
||||
description: 'Help translate Material into more languages'
|
||||
title: 'New translation: {Insert language}'
|
||||
labels: [enhancement]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |-
|
||||
## Instructions
|
||||
|
||||
1. Check, if your language is already available: [here](https://bit.ly/33vFDD0)
|
||||
2. If it isn't, please translate the labels on the right:
|
||||
|
||||
```jinja
|
||||
{% macro t(key) %}{{ {
|
||||
"language": "en",
|
||||
"direction": "ltr",
|
||||
"clipboard.copy": "Copy to clipboard",
|
||||
"clipboard.copied": "Copied to clipboard",
|
||||
"edit.link.title": "Edit this page",
|
||||
"footer.previous": "Previous",
|
||||
"footer.next": "Next",
|
||||
"footer.title": "Footer",
|
||||
"header.title": "Header",
|
||||
"meta.comments": "Comments",
|
||||
"meta.source": "Source",
|
||||
"nav.title": "Navigation",
|
||||
"search.config.lang": "en",
|
||||
"search.config.pipeline": "trimmer, stopWordFilter",
|
||||
"search.config.separator": "[\s\-]+",
|
||||
"search.placeholder": "Search",
|
||||
"search.reset": "Clear",
|
||||
"search.result.initializer": "Initializing search",
|
||||
"search.result.placeholder": "Type to start searching",
|
||||
"search.result.none": "No matching documents",
|
||||
"search.result.one": "1 matching document",
|
||||
"search.result.other": "# matching documents",
|
||||
"search.result.more.one": "1 more on this page",
|
||||
"search.result.more.other": "# more on this page",
|
||||
"search.result.term.missing": "Missing",
|
||||
"select.language.title": "Select language",
|
||||
"select.version.title": "Select version",
|
||||
"skip.link.title": "Skip to content",
|
||||
"source.link.title": "Go to repository",
|
||||
"source.file.date.updated": "Last update",
|
||||
"source.file.date.created": "Created",
|
||||
"tabs.title": "Tabs",
|
||||
"toc.title": "Table of contents",
|
||||
"top.title": "Back to top"
|
||||
}[key] }}{% endmacro %}
|
||||
```
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Translation
|
||||
description: Put your translated file here. The text is automatically formatted as Jinja code
|
||||
placeholder: |-
|
||||
{% macro t(key) %}{{ {
|
||||
"language": "en",
|
||||
"direction": "ltr",
|
||||
...
|
||||
}[key] }}{% endmacro %}
|
||||
render: jinja
|
||||
validations:
|
||||
required: true
|
||||
Loading…
Reference in New Issue
Block a user