Skip to content

Commit

Permalink
Edit the BUG template
Browse files Browse the repository at this point in the history
Convert the NEW_FEATURE template

Convert the NEW_TOPIC template

Convert TOPIC_CLARIFICATION

Configuring the template chooser

Rename the issue template files to change the order

Clarification about an issue with the actual product
  • Loading branch information
dshevtsov committed Feb 23, 2022
1 parent 4a85ad0 commit 2c619f7
Show file tree
Hide file tree
Showing 8 changed files with 116 additions and 119 deletions.
40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/NEW_FEATURE.md

This file was deleted.

39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/NEW_TOPIC.md

This file was deleted.

36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/TOPIC_CLARIFICATION.md

This file was deleted.

11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Help Center
url: https://support.magento.com/hc/en-us
about: Find help with issues unrelated to documentation here.
- name: Community resources
url: https://developer.adobe.com/open/magento
about: Find more resources here.
- name: Contact the team
url: https://magentocommeng.slack.com/messages/CAN932A3H
about: Ask and answer questions directly with the team.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/incorrect_topic.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Incorrect or unclear topic
description: "Unclear or incorrect documentation: ambiguous guidelines, wrong or obsolete examples, typos, etc."
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report this issue!
This request should only relate to the content of the devdocs.magento.com website.
If you are having an issue with the actual product (as opposed to the docs), search the [Help Center](https://support.magento.com/hc/en-us) or report it as a [codebase issue](https://devdocs.magento.com/contributor-guide/contributing.html#report).
Requests that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the documentation you are requesting.
options:
- label: I have searched the existing issues
required: true
- type: input
attributes:
label: Which topic?
description: A link to the topic that needs clarification or correction
placeholder: "Example: https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements.html"
validations:
required: true
- type: textarea
attributes:
label: What's wrong with the content?
validations:
required: true
- type: textarea
attributes:
label: What changes do you propose?
- type: textarea
attributes:
label: Anything else that can help to cover this?
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/missing_content.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Missing content
description: Undocumented feature, service, command, API, UI component, procedure, etc.
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report this issue!
This request should only relate to the content of the devdocs.magento.com website.
If you are having an issue with the actual product (as opposed to the docs), search the [Help Center](https://support.magento.com/hc/en-us) or report it as a [codebase issue](https://devdocs.magento.com/contributor-guide/contributing.html#report).
Requests that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the documentation you are requesting.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: What's missing?
placeholder: |
- In the <guide name> or <page link> ...
- Missing explanation of how ... works.
- Missing steps or guidelines for ....
- Missing code samples to demonstrate ....
- Something else ...
validations:
required: true
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Bug report
description: Technical issue with https://devdocs.magento.com/
name: Site bug
description: Something isn't working on devdocs.magento.com or when building the website locally.
labels: ["bug"]
assignees:
- dshevtsov
Expand All @@ -8,8 +8,8 @@ body:
attributes:
value: |
Thank you for taking the time to report this issue!
GitHub Issues in this repo should relate to this project's codebase.
Before submitting this issue, please make sure you are complying with our [Code of Conduct](https://github.com/magento/devdocs/blob/master/.github/CODE_OF_CONDUCT.md).
This bug report should only relate to the devdocs website itself or non-content issues such as when building locally or running rake commands.
If you are having an issue with the actual product (as opposed to the docs), search the [Help Center](https://support.magento.com/hc/en-us) or report it as a [codebase issue](https://devdocs.magento.com/contributor-guide/contributing.html#report).
Issues that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
- type: checkboxes
attributes:
Expand Down
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/site_feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Site feature request
description: Propose a new functionality or an improvement of the devdocs.magento.com website or of the local development tools.
labels: ["Site Improvements"]
assignees:
- dshevtsov
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report this issue!
This feature request should only relate to the devdocs website itself or other non-content request such as rake commands.
If you are having an issue with the actual product (as opposed to the docs), search the [Help Center](https://support.magento.com/hc/en-us) or report it as a [codebase issue](https://devdocs.magento.com/contributor-guide/contributing.html#report).
Requests that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the feature you are requesting.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: What feature should be added?
validations:
required: true
- type: textarea
attributes:
label: What is the expected behavior?
validations:
required: true
- type: textarea
attributes:
label: How will this feature improve the user experience?
validations:
required: true
- type: textarea
attributes:
label: What would a solution for this issue look like?

0 comments on commit 2c619f7

Please sign in to comment.