Skip to content

Commit

Permalink
Merge pull request #1472 from AgoraIO/issue-template-noblank
Browse files Browse the repository at this point in the history
Issue Template Updates
  • Loading branch information
billy-the-fish authored Sep 27, 2023
2 parents 5e2244a + ff9baa4 commit e10c393
Show file tree
Hide file tree
Showing 6 changed files with 155 additions and 26 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/.docs-update-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Docs update issue
about: Request an update to a doc
title: ''
labels: 'Bug'
assignees: saudsami, atovpeko

---

**SDK/Product**

<!-- Signaling, Broadcast Streaming, Voice... -->

**Business case**:
<!-- How will this issue help Agora customers or yourself? -->

**Subject Matter Expert**:
<!--
- *Technical*: @saudsami
- *Language*: @atovpeko
-->

**Doc Link**
<!-- Add links to any examples of the missing/incorrect docs, if applicable -->

**Scope**:
<!-- The products and documents to be updated. If you are not sure, leave it to @atovpeko. -->

**Acceptance criteria**:

- technically correct
- easy to use
- follows the template structure
- follows the Google Developer Style Guide

**Additional valuable information**

<!-- Anything else that will help with this issue? (For example screenshots) -->
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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?
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/docs-update-issue.md

This file was deleted.

5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/milestone-management.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
name: Milestone management
name: [Internal] Milestone management
about: Checklist for milestone tasks
title: Milestone management
labels: ''
assignees: atovpeko

---

<!-- This Issue is for Agora use only -->

Take the following project management steps to fulfill this milestone:

- [ ] Run the full scope of the proposed EN doc updates by the PO
Expand Down
105 changes: 105 additions & 0 deletions .github/ISSUE_TEMPLATE/new-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
name: Docs update request
description: Request an update or correction to documentation
title: "[Bug]: "
labels: 'Bug'
assignees: saudsami, atovpeko

body:
- type: dropdown
id: platform
attributes:
label: Platform
description: Select the platform for the documentation update.
options:
- Android
- iOS
- Web
- macOS
- Windows
- Electron
- Unity
- Flutter
- React Native
- Other
validations:
required: true

- type: dropdown
id: product
attributes:
label: Product
description: Select the product for the documentation update.
options:
- Video Calling
- Interactive Live Streaming
- Voice Calling
- Broadcast Streaming
- Chat
- Signaling
- Interactive Whiteboard
- IoT SDK
- Other
validations:
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.
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.
validations:
required: true

- type: textarea
id: subject_matter_expert
attributes:
label: Subject Matter Expert
placeholder: |
Technical: @saudsami
Language: @atovpeko
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.
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.
validations:
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.
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.
validations:
required: false
Original file line number Diff line number Diff line change
@@ -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 Title>' doc in POC3 style
labels: ''
labels: 'enhancement'
assignees: saudsami

---

<!-- This Issue is for Agora use only -->

**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-<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

**Subject Matter Expert**:
Expand Down

0 comments on commit e10c393

Please sign in to comment.