From 7eb5c44375dbc553ea56c063a50f262ae366f1fd Mon Sep 17 00:00:00 2001 From: Max Cobb Date: Tue, 26 Sep 2023 11:55:12 +0100 Subject: [PATCH 1/4] updated existing issues to show whether they are reserved for internal use. disabled blank issues. --- .github/ISSUE_TEMPLATE/config.yml | 5 ++++ .github/ISSUE_TEMPLATE/docs-update-issue.md | 30 +++++++++++++------ .../ISSUE_TEMPLATE/milestone-management.md | 5 ++-- ...ument-according-to-the-new-architecture.md | 6 ++-- 4 files changed, 33 insertions(+), 13 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..6e93df43a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: SDK Bugs and Feature Requests + url: https://agora-ticket.agora.io/ + about: Do you have a bug or feature request related to one of Agora's SDKs? \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/docs-update-issue.md b/.github/ISSUE_TEMPLATE/docs-update-issue.md index d3ea6cad8..29bc828c1 100644 --- a/.github/ISSUE_TEMPLATE/docs-update-issue.md +++ b/.github/ISSUE_TEMPLATE/docs-update-issue.md @@ -2,21 +2,33 @@ name: Docs update issue about: Request an update to a doc title: '' -labels: '' +labels: 'Bug' assignees: saudsami, atovpeko --- -**Business case**: How will this issue help our customers? +**Business case**: + **Subject Matter Expert**: -- *Technical*: -- *Language*: Iain -- *PM*: only if essential + -**Scope**: The products and documents to be updated. If you are not sure, leave it to Iain. +**Doc Link** + -**Acceptance criteria**: The documentation is technically correct, easy to use, follows the template structure and -follows the Google Developer Style Guide. +**Scope**: + -**Additional valuable information**: Anything else that will help with this issue? +**Acceptance criteria**: + +- technically correct +- easy to use +- follows the template structure +- follows the Google Developer Style Guide + +**Additional valuable information** + + diff --git a/.github/ISSUE_TEMPLATE/milestone-management.md b/.github/ISSUE_TEMPLATE/milestone-management.md index 8f6942816..27f290aac 100644 --- a/.github/ISSUE_TEMPLATE/milestone-management.md +++ b/.github/ISSUE_TEMPLATE/milestone-management.md @@ -1,12 +1,13 @@ --- -name: Milestone management +name: [Internal] Milestone management about: Checklist for milestone tasks title: Milestone management labels: '' assignees: atovpeko - --- + + Take the following project management steps to fulfill this milestone: - [ ] Run the full scope of the proposed EN doc updates by the PO diff --git a/.github/ISSUE_TEMPLATE/rewrite-a-document-according-to-the-new-architecture.md b/.github/ISSUE_TEMPLATE/rewrite-a-document-according-to-the-new-architecture.md index 96680e3ad..3ef2d26e6 100644 --- a/.github/ISSUE_TEMPLATE/rewrite-a-document-according-to-the-new-architecture.md +++ b/.github/ISSUE_TEMPLATE/rewrite-a-document-according-to-the-new-architecture.md @@ -1,12 +1,14 @@ --- -name: Rewrite a document according to the new architecture +name: [Internal] Rewrite a document according to the new architecture about: Describe this issue template's purpose here. title: Rewrite the '' doc in POC3 style -labels: '' +labels: 'enhancement' assignees: saudsami --- + + **Business case**: The POC3 reference app simplifies the integration process of Video SDK. Clients can simply clone the code repository to experience and test product features. Add code for the implementation of **Document title** to the `video-sdk-samples-` code repository. Update the document to POC3 style and include the updated code. Use conditional blocks, where required, to create variants for Interactive live streaming, Broadcast Streaming, and Voice calling **Subject Matter Expert**: From 59047b934ffab2485f645ec7540dbc91f4bf6507 Mon Sep 17 00:00:00 2001 From: Max Cobb Date: Tue, 26 Sep 2023 11:56:46 +0100 Subject: [PATCH 2/4] added SDK/Product section to doc update issue template --- .github/ISSUE_TEMPLATE/docs-update-issue.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/docs-update-issue.md b/.github/ISSUE_TEMPLATE/docs-update-issue.md index 29bc828c1..0764360b4 100644 --- a/.github/ISSUE_TEMPLATE/docs-update-issue.md +++ b/.github/ISSUE_TEMPLATE/docs-update-issue.md @@ -7,6 +7,10 @@ assignees: saudsami, atovpeko --- +**SDK/Product** + + + **Business case**: From f486f7184506eb8743f3c957583d08f9474ca64b Mon Sep 17 00:00:00 2001 From: Max Cobb Date: Tue, 26 Sep 2023 14:25:18 +0100 Subject: [PATCH 3/4] update to use yaml syntax forms --- ...-update-issue.md => .docs-update-issue.md} | 2 +- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/new-issue.yml | 96 +++++++++++++++++++ 3 files changed, 98 insertions(+), 2 deletions(-) rename .github/ISSUE_TEMPLATE/{docs-update-issue.md => .docs-update-issue.md} (90%) create mode 100644 .github/ISSUE_TEMPLATE/new-issue.yml diff --git a/.github/ISSUE_TEMPLATE/docs-update-issue.md b/.github/ISSUE_TEMPLATE/.docs-update-issue.md similarity index 90% rename from .github/ISSUE_TEMPLATE/docs-update-issue.md rename to .github/ISSUE_TEMPLATE/.docs-update-issue.md index 0764360b4..a337bcb9a 100644 --- a/.github/ISSUE_TEMPLATE/docs-update-issue.md +++ b/.github/ISSUE_TEMPLATE/.docs-update-issue.md @@ -35,4 +35,4 @@ assignees: saudsami, atovpeko **Additional valuable information** - + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 6e93df43a..d523e7c64 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - - name: SDK Bugs and Feature Requests + - name: SDK bugs and feature requests. url: https://agora-ticket.agora.io/ about: Do you have a bug or feature request related to one of Agora's SDKs? \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/new-issue.yml b/.github/ISSUE_TEMPLATE/new-issue.yml new file mode 100644 index 000000000..8fe328121 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-issue.yml @@ -0,0 +1,96 @@ +name: Docs Update Request +about: Request an update or correction to documentation +title: '' +labels: 'Bug' +assignees: saudsami, atovpeko + +body: + - type: dropdown + id: platform + attributes: + label: Platform + description: Select the platform for the documentation update. + choices: + - Android + - iOS + - Web + - macOS + - Windows + - Electron + - Unity + - Flutter + - React Native + - Other + required: true + + - type: dropdown + id: product + attributes: + label: Product + description: Select the product for the documentation update. + choices: + - Video Calling + - Interactive Live Streaming + - Voice Calling + - Broadcast Streaming + - Chat + - Signaling + - Interactive Whiteboard + - IoT SDK + - Other + required: true + + - type: text + id: other_product + attributes: + label: Other Product + description: Enter the name of the product if you selected "Other" in the previous dropdown. + required: false + + - type: textarea + id: business_case + attributes: + label: Business Case + description: Explain how addressing this documentation issue will benefit Agora customers or yourself. + required: true + + - type: textarea + id: subject_matter_expert + attributes: + label: Subject Matter Expert + placeholder: | + Technical: @saudsami + Language: @atovpeko + required: false + + - type: textarea + id: documentation_link + attributes: + label: Documentation Link + description: Provide links to the relevant documentation that needs an update or correction. + required: true + + - type: textarea + id: scope + attributes: + label: Scope + description: Indicate the products and documents that should be updated. If unsure, leave it to @atovpeko to decide. + required: false + + - type: textarea + id: acceptance_criteria + attributes: + label: Acceptance Criteria + placeholder: | + - The documentation update must be technically accurate. + - It should be easy for users to follow and understand. + - It should adhere to the template structure. + - It should follow the Google Developer Style Guide. + required: true + + - type: textarea + id: additional_information + attributes: + label: Additional Information + description: Include any additional details, such as screenshots or context, that will help in addressing this documentation issue. + required: false From ff9baa40f4dc6aae4f5c1d4dcb37a171768a922a Mon Sep 17 00:00:00 2001 From: Max Cobb Date: Tue, 26 Sep 2023 14:31:52 +0100 Subject: [PATCH 4/4] fix yaml formatting of issue forms --- .github/ISSUE_TEMPLATE/new-issue.yml | 39 +++++++++++++++++----------- 1 file changed, 24 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/new-issue.yml b/.github/ISSUE_TEMPLATE/new-issue.yml index 8fe328121..2b3bb5928 100644 --- a/.github/ISSUE_TEMPLATE/new-issue.yml +++ b/.github/ISSUE_TEMPLATE/new-issue.yml @@ -1,6 +1,6 @@ -name: Docs Update Request -about: Request an update or correction to documentation -title: '' +name: Docs update request +description: Request an update or correction to documentation +title: "[Bug]: " labels: 'Bug' assignees: saudsami, atovpeko @@ -10,7 +10,7 @@ body: attributes: label: Platform description: Select the platform for the documentation update. - choices: + options: - Android - iOS - Web @@ -21,14 +21,15 @@ body: - Flutter - React Native - Other - required: true + validations: + required: true - type: dropdown id: product attributes: label: Product description: Select the product for the documentation update. - choices: + options: - Video Calling - Interactive Live Streaming - Voice Calling @@ -38,21 +39,24 @@ body: - Interactive Whiteboard - IoT SDK - Other - required: true + validations: + required: true - - type: text + - type: textarea id: other_product attributes: label: Other Product description: Enter the name of the product if you selected "Other" in the previous dropdown. - required: false + validations: + required: false - type: textarea id: business_case attributes: label: Business Case description: Explain how addressing this documentation issue will benefit Agora customers or yourself. - required: true + validations: + required: true - type: textarea id: subject_matter_expert @@ -61,21 +65,24 @@ body: placeholder: | Technical: @saudsami Language: @atovpeko - required: false + validations: + required: false - type: textarea id: documentation_link attributes: label: Documentation Link description: Provide links to the relevant documentation that needs an update or correction. - required: true + validations: + required: true - type: textarea id: scope attributes: label: Scope description: Indicate the products and documents that should be updated. If unsure, leave it to @atovpeko to decide. - required: false + validations: + required: false - type: textarea id: acceptance_criteria @@ -86,11 +93,13 @@ body: - It should be easy for users to follow and understand. - It should adhere to the template structure. - It should follow the Google Developer Style Guide. - required: true + validations: + required: true - type: textarea id: additional_information attributes: label: Additional Information description: Include any additional details, such as screenshots or context, that will help in addressing this documentation issue. - required: false + validations: + required: false