-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #94 from alphagov/create-issue-template-for-updati…
…ng-existing-docs Created templates for updating exisitng documentation
- Loading branch information
Showing
3 changed files
with
87 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
name: Update component documentaiton | ||
description: Update the documentation of a component within the GOV.UK Publishing Design Guide | ||
title: "Update [Enter the name of the component]" | ||
labels: ["component", "update documentation"] | ||
projects: ["alphagov/99"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
# Steps to creating a component documentation update | ||
- Update the title to the component documentation that needs updating | ||
- In the textarea below, list out all the sections within the documentation that has yet to be entered | ||
- type: textarea | ||
attributes: | ||
label: "Documentation sections with missing data" | ||
description: "List out all the sections as task list items" | ||
value: | | ||
- [ ] Add section that needs to be documented for this component | ||
- [ ] Add section that needs to be documented for this component | ||
- [ ] Add section that needs to be documented for this component | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: "Additional comments" | ||
- type: markdown | ||
attributes: | ||
value: "Once you've completed the above steps, team members are then able to convert an item on the task list as and individual issue to work on." | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
name: Update pattern documentation | ||
description: Update the documentation of a pattern within the GOV.UK Publishing Design Guide | ||
title: "Update [Enter the name of the pattern]" | ||
labels: ["pattern", "update documentation"] | ||
projects: ["alphagov/99"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
# Steps to creating a pattern documentation update | ||
- Update the title to the pattern documentation that needs updating | ||
- In the textarea below, list out all the sections within the documentation that has yet to be entered | ||
- type: textarea | ||
attributes: | ||
label: "Documentation sections with missing data" | ||
description: "List out all the sections as task list items" | ||
value: | | ||
- [ ] Add section that needs to be documented for this pattern | ||
- [ ] Add section that needs to be documented for this pattern | ||
- [ ] Add section that needs to be documented for this pattern | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: "Additional comments" | ||
- type: markdown | ||
attributes: | ||
value: "Once you've completed the above steps, team members are then able to convert an item on the task list as and individual issue to work on." | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
name: Update frontend template documenation | ||
description: Update the documentation of a frontend template within the GOV.UK Publishing Design Guide | ||
title: "Update [Enter the name of the frontend template]" | ||
labels: ["frontend template", "update documentation"] | ||
projects: ["alphagov/99"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
# Steps to creating a frontend template documentation update | ||
- Update the title to the frontend template documentation that needs updating | ||
- In the textarea below, list out all the sections within the documentation that has yet to be entered | ||
- type: textarea | ||
attributes: | ||
label: "Documentation sections with missing data" | ||
description: "List out all the sections as task list items" | ||
value: | | ||
- [ ] Add section that needs to be documented for this frontend template | ||
- [ ] Add section that needs to be documented for this frontend template | ||
- [ ] Add section that needs to be documented for this frontend template | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: "Additional comments" | ||
- type: markdown | ||
attributes: | ||
value: "Once you've completed the above steps, team members are then able to convert an item on the task list as and individual issue to work on." | ||
|