From 3506a9ad02a9d9ae7b5e854f9fc0e1f50fb45871 Mon Sep 17 00:00:00 2001 From: Patience Daur Date: Fri, 21 Jan 2022 14:02:09 +0300 Subject: [PATCH 1/5] Remove unused information --- .github/ISSUE_TEMPLATE/document.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/document.md b/.github/ISSUE_TEMPLATE/document.md index f51a5c8aa2..61c45b2176 100644 --- a/.github/ISSUE_TEMPLATE/document.md +++ b/.github/ISSUE_TEMPLATE/document.md @@ -5,16 +5,11 @@ title: "[0pt] {feature_name}" labels: assignees: --- -# Feature name - -Fill in whatever you know at the moment. - **Product:** Tarantool, Cartridge, TDG, connectors, tools? **Since:** product version **Audience/target:** who will read it and for what task? **Root document:** where to add or update documentation **SME:** @ expert to ask for more information -**Peer reviewer:** @ documentarian name # Details @@ -43,4 +38,4 @@ Fill in whatever you know at the moment. - [ ] Estimate complexity in storypoints in the title - [ ] Add to **Documentation** board → **Backlog** -> Note: issue templates are in beta. Give your feedback in #1869. \ No newline at end of file +> Note: issue templates are in beta. Give your feedback in #1869. From 49f7a1471f42c286738ec0da04d90c14a4ac5d2c Mon Sep 17 00:00:00 2001 From: Patience Daur Date: Fri, 21 Jan 2022 14:28:05 +0300 Subject: [PATCH 2/5] Minor changes --- .github/ISSUE_TEMPLATE/document.md | 2 +- .github/ISSUE_TEMPLATE/epic.md | 17 +++++++++++++++++ .github/ISSUE_TEMPLATE/fix.md | 2 +- .github/ISSUE_TEMPLATE/translate.md | 2 +- 4 files changed, 20 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/epic.md diff --git a/.github/ISSUE_TEMPLATE/document.md b/.github/ISSUE_TEMPLATE/document.md index 61c45b2176..4a063b1ebe 100644 --- a/.github/ISSUE_TEMPLATE/document.md +++ b/.github/ISSUE_TEMPLATE/document.md @@ -1,5 +1,5 @@ --- -name: Write or Update +name: Write or update about: Write or update a documentation page title: "[0pt] {feature_name}" labels: diff --git a/.github/ISSUE_TEMPLATE/epic.md b/.github/ISSUE_TEMPLATE/epic.md new file mode 100644 index 0000000000..196129da4f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/epic.md @@ -0,0 +1,17 @@ +--- +name: Epic +about: Create an umbrella ticket for future release documentation +title: "[Epic] {epic_name}" +labels: +assignees: +--- +**Related dev. issue(s):** GitHub link(s) +**PM ref.:** Notion link +**SME:** @ expert to ask for more information + +# Details + +- [ ] GitHub issue +- [ ] GitHub issue + +Provide any details you consider necessary. diff --git a/.github/ISSUE_TEMPLATE/fix.md b/.github/ISSUE_TEMPLATE/fix.md index df8acad862..9e97983fc2 100644 --- a/.github/ISSUE_TEMPLATE/fix.md +++ b/.github/ISSUE_TEMPLATE/fix.md @@ -1,5 +1,5 @@ --- -name: Fix & Proofread +name: Fix & proofread about: Fix typos, proofread document title: "[0pt] Fix {document_title}" labels: typo diff --git a/.github/ISSUE_TEMPLATE/translate.md b/.github/ISSUE_TEMPLATE/translate.md index 3841e2865f..496ee24414 100644 --- a/.github/ISSUE_TEMPLATE/translate.md +++ b/.github/ISSUE_TEMPLATE/translate.md @@ -3,7 +3,7 @@ name: Translate about: Translation issue title: "[0pt] Translate {document_title}" labels: localization -assignees: ladyune +assignees: --- ## Info From f97024960c260fac8897777af974d2d4b3607b6f Mon Sep 17 00:00:00 2001 From: Patience Daur Date: Fri, 21 Jan 2022 14:29:01 +0300 Subject: [PATCH 3/5] Add epic templates --- .github/ISSUE_TEMPLATE/tech.md | 9 +++------ .github/ISSUE_TEMPLATE/tech_debt_epic.md | 14 ++++++++++++++ 2 files changed, 17 insertions(+), 6 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/tech_debt_epic.md diff --git a/.github/ISSUE_TEMPLATE/tech.md b/.github/ISSUE_TEMPLATE/tech.md index 7585a8bec9..ac6edd0136 100644 --- a/.github/ISSUE_TEMPLATE/tech.md +++ b/.github/ISSUE_TEMPLATE/tech.md @@ -1,6 +1,6 @@ --- name: Technical/internal issue -about: Technical debt in the docs +about: Technical issue in the docs title: "[0pt] {do X}" labels: internal assignees: @@ -16,11 +16,8 @@ assignees: # Planning checklist -- [ ] Pick label: - - [CI/CD](https://github.com/tarantool/doc/labels/CI/CD) - - [localization](https://github.com/tarantool/doc/labels/localization) - - or others. +- [ ] Pick a label - [ ] Estimate complexity in storypoints in the title - [ ] Add to **Documentation** board → **Backlog** -> Note: issue templates are in beta. Give your feedback in #1869. \ No newline at end of file +> Note: issue templates are in beta. Give your feedback in #1869. diff --git a/.github/ISSUE_TEMPLATE/tech_debt_epic.md b/.github/ISSUE_TEMPLATE/tech_debt_epic.md new file mode 100644 index 0000000000..b6362229c0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/tech_debt_epic.md @@ -0,0 +1,14 @@ +--- +name: Technical debt epic +about: Umbrella ticket for technical debt in the docs +title: "[Tech debt] {epic_name}" +labels: +assignees: +--- + +# Details + +- [ ] GitHub issue +- [ ] GitHub issue + +Provide any details you consider necessary. From 8463a8d0cd2fa67242b28f098176cf7f03cdc673 Mon Sep 17 00:00:00 2001 From: Patience Daur Date: Tue, 25 Jan 2022 08:48:18 +0300 Subject: [PATCH 4/5] Add the epic label to epics --- .github/ISSUE_TEMPLATE/epic.md | 2 +- .github/ISSUE_TEMPLATE/tech_debt_epic.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/epic.md b/.github/ISSUE_TEMPLATE/epic.md index 196129da4f..3e3e7c462e 100644 --- a/.github/ISSUE_TEMPLATE/epic.md +++ b/.github/ISSUE_TEMPLATE/epic.md @@ -2,7 +2,7 @@ name: Epic about: Create an umbrella ticket for future release documentation title: "[Epic] {epic_name}" -labels: +labels: epic assignees: --- **Related dev. issue(s):** GitHub link(s) diff --git a/.github/ISSUE_TEMPLATE/tech_debt_epic.md b/.github/ISSUE_TEMPLATE/tech_debt_epic.md index b6362229c0..c6637db4eb 100644 --- a/.github/ISSUE_TEMPLATE/tech_debt_epic.md +++ b/.github/ISSUE_TEMPLATE/tech_debt_epic.md @@ -2,7 +2,7 @@ name: Technical debt epic about: Umbrella ticket for technical debt in the docs title: "[Tech debt] {epic_name}" -labels: +labels: epic assignees: --- From 9244e7865d319bcb402f2616891a42165d22e3f0 Mon Sep 17 00:00:00 2001 From: Patience Daur Date: Tue, 25 Jan 2022 13:00:56 +0300 Subject: [PATCH 5/5] Add dev.epic line for epics and dev.issue line for regular issues --- .github/ISSUE_TEMPLATE/document.md | 2 ++ .github/ISSUE_TEMPLATE/epic.md | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/document.md b/.github/ISSUE_TEMPLATE/document.md index 4a063b1ebe..e970681151 100644 --- a/.github/ISSUE_TEMPLATE/document.md +++ b/.github/ISSUE_TEMPLATE/document.md @@ -5,6 +5,8 @@ title: "[0pt] {feature_name}" labels: assignees: --- +**Related dev. issue(s):** GitHub link(s) + **Product:** Tarantool, Cartridge, TDG, connectors, tools? **Since:** product version **Audience/target:** who will read it and for what task? diff --git a/.github/ISSUE_TEMPLATE/epic.md b/.github/ISSUE_TEMPLATE/epic.md index 3e3e7c462e..db8230080d 100644 --- a/.github/ISSUE_TEMPLATE/epic.md +++ b/.github/ISSUE_TEMPLATE/epic.md @@ -5,7 +5,7 @@ title: "[Epic] {epic_name}" labels: epic assignees: --- -**Related dev. issue(s):** GitHub link(s) +**Related dev. epic:** GitHub link **PM ref.:** Notion link **SME:** @ expert to ask for more information