Skip to content

Commit

Permalink
Merge pull request #1477 from AgoraIO/issue-template-noblank
Browse files Browse the repository at this point in the history
Yaml Issues
  • Loading branch information
maxxfrazer authored Oct 24, 2023
2 parents dfd4295 + 18fba49 commit 8d64713
Show file tree
Hide file tree
Showing 6 changed files with 119 additions and 131 deletions.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/.docs-update-issue.md

This file was deleted.

19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/milestone-management.md

This file was deleted.

36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/milestone-management.yml
Original file line number Diff line number Diff line change
@@ -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
12 changes: 9 additions & 3 deletions .github/ISSUE_TEMPLATE/new-issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ body:
label: Platform
description: Select the platform for the documentation update.
options:
- All or multiple (please specify)
- Android
- iOS
- Web
Expand All @@ -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
Expand All @@ -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

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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 Title>' 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-<platform>` 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: <document-link>
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

0 comments on commit 8d64713

Please sign in to comment.