diff --git a/.github/ISSUE_TEMPLATE/.docs-update-issue.md b/.github/ISSUE_TEMPLATE/.docs-update-issue.md deleted file mode 100644 index a337bcb9a..000000000 --- a/.github/ISSUE_TEMPLATE/.docs-update-issue.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Docs update issue -about: Request an update to a doc -title: '' -labels: 'Bug' -assignees: saudsami, atovpeko - ---- - -**SDK/Product** - - - -**Business case**: - - -**Subject Matter Expert**: - - -**Doc Link** - - -**Scope**: - - -**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 deleted file mode 100644 index 27f290aac..000000000 --- a/.github/ISSUE_TEMPLATE/milestone-management.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -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 -- [ ] Merge all PRs and close relevant tickets when the work is done -- [ ] Create and share a Vercel instance for review and stakeholder signoff -- [ ] Implement comments from stakeholders until fully resolved -- [ ] Publish updates to https://docs.agora.io/en/ -- [ ] Inform the stakeholders -- [ ] Close the milestone diff --git a/.github/ISSUE_TEMPLATE/milestone-management.yml b/.github/ISSUE_TEMPLATE/milestone-management.yml new file mode 100644 index 000000000..ae2f0eae7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/milestone-management.yml @@ -0,0 +1,36 @@ +name: "[Internal] Milestone management" +description: Checklist for milestone tasks +title: "[Internal] Milestone management" +labels: 'Enhancement' +assignees: atovpeko + +body: + - type: markdown + attributes: + value: "❗️ This Issue template is for Agora use only ❗️" + + - type: textarea + attributes: + label: Details + validations: + required: true + + - type: checkboxes + id: tasks + attributes: + label: "Take the following project management steps to fulfill this milestone:" + options: + - label: "Run the full scope of the proposed EN doc updates by the PO" + required: false + - label: "Merge all PRs and close relevant tickets when the work is done" + required: false + - label: "Create and share a Vercel instance for review and stakeholder signoff" + required: false + - label: "Implement comments from stakeholders until fully resolved" + required: false + - label: "Publish updates to https://docs.agora.io/en/" + required: false + - label: "Inform the stakeholders" + required: false + - label: "Close the milestone" + required: false diff --git a/.github/ISSUE_TEMPLATE/new-issue.yml b/.github/ISSUE_TEMPLATE/new-issue.yml index 2b3bb5928..bd31b8a2f 100644 --- a/.github/ISSUE_TEMPLATE/new-issue.yml +++ b/.github/ISSUE_TEMPLATE/new-issue.yml @@ -11,6 +11,7 @@ body: label: Platform description: Select the platform for the documentation update. options: + - All or multiple (please specify) - Android - iOS - Web @@ -24,12 +25,19 @@ body: validations: required: true + - type: textarea + attributes: + label: Platform details + validations: + required: false + - type: dropdown id: product attributes: label: Product description: Select the product for the documentation update. options: + - All or multiple (please specify) - Video Calling - Interactive Live Streaming - Voice Calling @@ -43,10 +51,8 @@ body: required: true - type: textarea - id: other_product attributes: - label: Other Product - description: Enter the name of the product if you selected "Other" in the previous dropdown. + label: Product details validations: required: false 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 deleted file mode 100644 index 3ef2d26e6..000000000 --- a/.github/ISSUE_TEMPLATE/rewrite-a-document-according-to-the-new-architecture.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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: '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**: -- *Technical*: Saud -- *Language*: Anastasia -- *PM*: Max (only if essential) - -**Scope**: The products and documents to be updated: -* The code repository for your platform. -* The README file in the sample code folder. -* The Video calling document for the feature: - -- [ ] [Android](https://github.com/AgoraIO/video-sdk-samples-android) - Saud - - [ ] Code repository - - [ ] README - - [ ] Product docs -- [ ] [iOS](https://github.com/AgoraIO/video-sdk-samples-ios) - Dasun - - [ ] Code repository - - [ ] README - - [ ] Product docs -- [ ] [Web](https://github.com/AgoraIO/video-sdk-samples-js) - Kishan - - [ ] Code repository - - [ ] README - - [ ] Product docs -- [ ] [macOS](https://github.com/AgoraIO/video-sdk-samples-macos) - Dasun - - [ ] Code repository - - [ ] README - - [ ] Product docs -- [ ] [Windows](https://github.com/AgoraIO/video-sdk-samples-windows) - Pankaj - - [ ] Code repository - - [ ] README - - [ ] Product docs -- [ ] [Electron](https://github.com/AgoraIO/video-sdk-samples-electron) - Kishan - - [ ] Code repository - - [ ] README - - [ ] Product docs -- [ ] [Unity](https://github.com/AgoraIO/video-sdk-samples-unity) - Hussain - - [ ] Code repository - - [ ] README - - [ ] Product docs -- [ ] [Flutter](https://github.com/AgoraIO/video-sdk-samples-flutter) - Saud - - [ ] Code repository - - [ ] README - - [ ] Product docs -- [ ] [React Native](https://github.com/AgoraIO/video-sdk-samples-reactnative) - Hussain - - [ ] Code repository - - [ ] README - - [ ] Product docs -- [ ] [Unreal Engine](https://github.com/AgoraIO/video-sdk-samples-unreal-engine) - Pankaj - - [ ] Code repository - - [ ] README - - [ ] Product docs - -**Acceptance criteria**: -* The code uses best practices, runs without errors, and demonstrates the product feature. -* The documentation is technically correct, easy to use, follows the template structure, and follows the Google Developer Style Guide. - -**Additional valuable information**: -* Branch from and merge to the milestone branch. -* Use the same branch name in the code and docs repositories diff --git a/.github/ISSUE_TEMPLATE/rewrite-a-document-according-to-the-new-architecture.yaml b/.github/ISSUE_TEMPLATE/rewrite-a-document-according-to-the-new-architecture.yaml new file mode 100644 index 000000000..e854bac42 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/rewrite-a-document-according-to-the-new-architecture.yaml @@ -0,0 +1,74 @@ +name: "[Internal] Rewrite a document according to the new architecture" +description: Describe this issue template's purpose here. +title: "Rewrite the '' doc in POC3 style" +labels: 'Enhancement' +assignees: saudsami + +body: + - type: markdown + attributes: + value: "❗️ This Issue template is for Agora use only ❗️" + + - type: textarea + id: business_case + attributes: + label: Business case + value: | + 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 + validations: + required: true + + - type: textarea + id: subject_matter_expert + attributes: + label: Subject Matter Expert + value: | + - Technical: Saud + - Language: Anastasia + - PM: Max (only if essential) + validations: + required: true + + - type: textarea + id: scope + attributes: + label: Scope + placeholder: | + The products and documents to be updated: + * The code repository for your platform. + * The README file in the sample code folder. + * The Video calling document for the feature: + validations: + required: true + + - type: textarea + id: platforms + attributes: + label: Platforms + placeholder: | + - [Android](https://github.com/AgoraIO/video-sdk-samples-android) - Saud + - [iOS](https://github.com/AgoraIO/video-sdk-samples-ios) - Dasun + - [Web](https://github.com/AgoraIO/video-sdk-samples-js) - Kishan + > ... (and similarly for all other platforms) + validations: + required: false + + - type: textarea + id: acceptance_criteria + attributes: + label: Acceptance criteria + placeholder: | + * The code uses best practices, runs without errors, and demonstrates the product feature. + * The documentation is technically correct, easy to use, follows the template structure, and follows the Google Developer Style Guide. + validations: + required: true + + - type: textarea + id: additional_valuable_information + attributes: + label: Additional valuable information + placeholder: | + * Branch from and merge to the milestone branch. + * Use the same branch name in the code and docs repositories + validations: + required: false