mirror of
https://github.com/woocommerce/woocommerce.git
synced 2025-08-18 10:21:16 +08:00
Update and consolidate the documentation issue template (#60111)
update and consolidate the documentation request issue templates to use proper label, yml format and team tag
This commit is contained in:
parent
de769e1497
commit
02c10d5363
3 changed files with 49 additions and 60 deletions
49
.github/ISSUE_TEMPLATE/documentation-improvement.yml
vendored
Normal file
49
.github/ISSUE_TEMPLATE/documentation-improvement.yml
vendored
Normal file
|
@ -0,0 +1,49 @@
|
|||
name: 📝 Suggestion for Documentation Improvement/Correction
|
||||
description: Propose a specific improvement or correction for an existing document.
|
||||
title: "[Documentation]: "
|
||||
labels: ["Documentation"]
|
||||
body:
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description of the Request
|
||||
description: |
|
||||
Clearly describe your request.
|
||||
|
||||
If suggesting an improvement or correction: Explain the changes you suggest to improve or correct the existing documentation. Be specific about any errors or areas of confusion you've identified.
|
||||
|
||||
If requesting new documentation: Provide a detailed description of the topic you'd like to see documented.
|
||||
placeholder: "Describe your suggestion or request in detail."
|
||||
|
||||
- type: textarea
|
||||
id: reason
|
||||
attributes:
|
||||
label: Reason for the Request
|
||||
description: Explain why this change or new document is important. Why do you believe it will make the documentation clearer, more accurate, or benefit the community?
|
||||
placeholder: "Explain the importance of this request."
|
||||
|
||||
- type: input
|
||||
id: page_link
|
||||
attributes:
|
||||
label: Link to the Page/Section (if applicable)
|
||||
description: Provide a link to the specific page or section that you're referring to, or indicate if this is a request for new documentation.
|
||||
placeholder: "https://github.com/woocommerce/woocommerce/..."
|
||||
|
||||
- type: textarea
|
||||
id: potential_content
|
||||
attributes:
|
||||
label: Potential Content
|
||||
description: If you have ideas about what the documentation should cover, list the points or sub-topics here.
|
||||
placeholder: "List potential topics or points to cover."
|
||||
|
||||
- type: textarea
|
||||
id: additional_context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Add any other context, references, or screenshots that support your suggestion or can help in the creation of new documentation.
|
||||
placeholder: "Add any extra context or references here."
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
cc @woocommerce/developer-advocacy
|
|
@ -1,30 +0,0 @@
|
|||
---
|
||||
name: "\U0001F4C4 Request for New Document"
|
||||
about: Suggest the creation of a new documentation topic that doesn't exist yet.
|
||||
title: "[DOC-REQ]"
|
||||
labels: 'type: documentation'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Description of the Document Requested
|
||||
|
||||
> Provide a detailed description of the topic you'd like to see documented.
|
||||
|
||||
|
||||
|
||||
## Why is this Document Important?
|
||||
|
||||
> Explain why this topic is crucial and how it can benefit the WooCommerce community.
|
||||
|
||||
|
||||
|
||||
## Potential Content
|
||||
|
||||
> If you have an idea about what the new document should cover, list the points or sub-topics here.
|
||||
|
||||
|
||||
|
||||
## Additional Context
|
||||
|
||||
> Add any other context, references, or information that can help in the creation of this new document.
|
|
@ -1,30 +0,0 @@
|
|||
---
|
||||
name: "\U0001F4DD Suggestion for Documentation Improvement/Correction"
|
||||
about: Propose a specific improvement or correction for an existing document.
|
||||
title: "[DOC-BUG]"
|
||||
labels: 'type: documentation'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Link to the Page/Section
|
||||
|
||||
> Provide a link to the specific page or section that you're referring to.
|
||||
|
||||
|
||||
|
||||
## Description of the Suggestion
|
||||
|
||||
> Describe the changes you suggest to improve or correct the documentation. Be specific about any errors or areas of confusion you've identified.
|
||||
|
||||
|
||||
|
||||
## Reason for the Suggestion
|
||||
|
||||
> Why do you believe this change will make the documentation clearer or more accurate?
|
||||
|
||||
|
||||
|
||||
## Additional Context
|
||||
|
||||
> Add any other context, references, or screenshots that support your suggestion.
|
Loading…
Add table
Add a link
Reference in a new issue