From db17472bd30965da6eee300253c64f121c1fdf17 Mon Sep 17 00:00:00 2001 From: nnagewad Date: Thu, 17 Oct 2024 16:45:25 +0100 Subject: [PATCH 1/2] Created templates for updating exisitng documentation --- .../ISSUE_TEMPLATE/04-update-component.yml | 29 +++++++++++++++++++ .github/ISSUE_TEMPLATE/05-update-pattern.yml | 29 +++++++++++++++++++ .../06-update-frontend-template.yml | 29 +++++++++++++++++++ 3 files changed, 87 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/04-update-component.yml create mode 100644 .github/ISSUE_TEMPLATE/05-update-pattern.yml create mode 100644 .github/ISSUE_TEMPLATE/06-update-frontend-template.yml diff --git a/.github/ISSUE_TEMPLATE/04-update-component.yml b/.github/ISSUE_TEMPLATE/04-update-component.yml new file mode 100644 index 0000000..f4ae2ef --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-update-component.yml @@ -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 a 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." + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/05-update-pattern.yml b/.github/ISSUE_TEMPLATE/05-update-pattern.yml new file mode 100644 index 0000000..8a6f335 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/05-update-pattern.yml @@ -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 a 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." + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/06-update-frontend-template.yml b/.github/ISSUE_TEMPLATE/06-update-frontend-template.yml new file mode 100644 index 0000000..fd4aa8d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/06-update-frontend-template.yml @@ -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 a 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." + \ No newline at end of file From 96b972e1caffd234d5a3efb642759482723f08bd Mon Sep 17 00:00:00 2001 From: nnagewad Date: Fri, 18 Oct 2024 11:18:07 +0100 Subject: [PATCH 2/2] Update sentence as suggested --- .github/ISSUE_TEMPLATE/04-update-component.yml | 2 +- .github/ISSUE_TEMPLATE/05-update-pattern.yml | 2 +- .github/ISSUE_TEMPLATE/06-update-frontend-template.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/04-update-component.yml b/.github/ISSUE_TEMPLATE/04-update-component.yml index f4ae2ef..9ad4977 100644 --- a/.github/ISSUE_TEMPLATE/04-update-component.yml +++ b/.github/ISSUE_TEMPLATE/04-update-component.yml @@ -13,7 +13,7 @@ body: - type: textarea attributes: label: "Documentation sections with missing data" - description: "List out all the sections as a task list items" + 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 diff --git a/.github/ISSUE_TEMPLATE/05-update-pattern.yml b/.github/ISSUE_TEMPLATE/05-update-pattern.yml index 8a6f335..832a918 100644 --- a/.github/ISSUE_TEMPLATE/05-update-pattern.yml +++ b/.github/ISSUE_TEMPLATE/05-update-pattern.yml @@ -13,7 +13,7 @@ body: - type: textarea attributes: label: "Documentation sections with missing data" - description: "List out all the sections as a task list items" + 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 diff --git a/.github/ISSUE_TEMPLATE/06-update-frontend-template.yml b/.github/ISSUE_TEMPLATE/06-update-frontend-template.yml index fd4aa8d..e744c73 100644 --- a/.github/ISSUE_TEMPLATE/06-update-frontend-template.yml +++ b/.github/ISSUE_TEMPLATE/06-update-frontend-template.yml @@ -13,7 +13,7 @@ body: - type: textarea attributes: label: "Documentation sections with missing data" - description: "List out all the sections as a task list items" + 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