From c4c70273266565c330fea1d3583f5f3ec375547a Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Thu, 24 Aug 2023 18:08:58 +0200 Subject: fix(bots): Add issue template for bots and a quick link to the docs in the readme Signed-off-by: Joas Schilling --- .github/ISSUE_TEMPLATE/1_bug_report.md | 107 ++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/2_feature_request.md | 27 +++++++ .github/ISSUE_TEMPLATE/3_bot_list.yml | 56 +++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 107 ---------------------------- .github/ISSUE_TEMPLATE/feature_request.md | 27 ------- README.md | 1 + 6 files changed, 191 insertions(+), 134 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1_bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/2_feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/3_bot_list.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.md b/.github/ISSUE_TEMPLATE/1_bug_report.md new file mode 100644 index 000000000..43e26c1cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug_report.md @@ -0,0 +1,107 @@ +--- +name: 🐞 Bug report +about: Help us to improve by reporting a bug +labels: 0. Needs triage, bug +--- + + + +### How to use GitHub + +* Please use the 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to show that you are affected by the same issue. +* Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue. +* Subscribe to receive notifications on status change and new comments. + +--- + +## Steps to reproduce +1. +2. +3. + +### Expected behaviour +Tell us what should happen + +### Actual behaviour +Tell us what happens instead + +## Talk app + +**Talk app version:** (see apps admin page: `/index.php/settings/apps`) + +**Custom Signaling server configured:** yes/no and version (see additional admin settings: `/index.php/index.php/settings/admin/talk#signaling_server`) + +**Custom TURN server configured:** yes/no (see additional admin settings: `/index.php/settings/admin/talk#turn_server`) + +**Custom STUN server configured:** yes/no (see additional admin settings: `/index.php/settings/admin/talk#stun_server`) + + +## Browser + +**Microphone available:** yes/no + +**Camera available:** yes/no + +**Operating system:** Windows/Ubuntu/... + +**Browser name:** Firefox/Chrome/... + +**Browser version:** 85/96/... + +### Browser log + +
+``` +Insert your browser log here, this could for example include: +a) The javascript console log +b) The network log +c) ... +``` + +
+ +## Server configuration + + + +**Operating system**: Ubuntu/RedHat/... + +**Web server:** Apache/Nginx + +**Database:** MySQL/Maria/SQLite/PostgreSQL + +**PHP version:** 8.0/8.1/8.2 + +**Nextcloud Version:** (see admin page) + +**List of activated apps:** + +
+ +``` +If you have access to your command line run e.g.: +sudo -u www-data php occ app:list +from within your server installation folder +``` +
+ +**Nextcloud configuration:** + +
+ +``` +If you have access to your command line run e.g.: +sudo -u www-data php occ config:list system +from within your Nextcloud installation folder +``` +
+ +### Server log (data/nextcloud.log) +
+ +``` +Insert your server log here +``` +
diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.md b/.github/ISSUE_TEMPLATE/2_feature_request.md new file mode 100644 index 000000000..b8f2426c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_feature_request.md @@ -0,0 +1,27 @@ +--- +name: 🚀 Feature request +about: Suggest an idea for Nextcloud Talk +labels: 0. Needs triage, enhancement +--- + + + +### How to use GitHub + +* Please use the 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to show that you are interested into the same feature. +* Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue. +* Subscribe to receive notifications on status change and new comments. + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/3_bot_list.yml b/.github/ISSUE_TEMPLATE/3_bot_list.yml new file mode 100644 index 000000000..9b59f1cda --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_bot_list.yml @@ -0,0 +1,56 @@ +name: 🤖 Add a Bot +description: 🤖 Request to add an existing bot to the docs/bot-list +title: "[🤖 Bot]: " +labels: ["1. to develop", "enhancement", "feature: bots 🤖"] +assignees: + - nickvergessen +body: +- type: input + id: botname + attributes: + label: Bot name + description: Should be the name users and moderators also see later on in the UI + placeholder: e.g. Call summary bot + validations: + required: true +- type: textarea + id: description + attributes: + label: Description + description: Useful, but short description, best to keep it to 1-3 lines of text. + placeholder: "The call summary bot posts an overview message after the call listing all participants and outlining tasks." + value: + validations: + required: true +- type: input + id: screenshot + attributes: + label: Screenshot URL + description: Max. width 700px, max. height 480px + placeholder: https://github.com/nextcloud/call_summary_bot/blob/main/docs/screenshot.png + validations: + required: true +- type: input + id: license + attributes: + label: License + description: Identifier of the license (See [https://spdx.org/licenses/](https://spdx.org/licenses/)) + placeholder: AGPL-3.0-or-later + validations: + required: true +- type: input + id: source + attributes: + label: Source code URL + description: Link to source code / repository + placeholder: https://github.com/nextcloud/call_summary_bot + validations: + required: true +- type: input + id: install + attributes: + label: Installation steps + description: Link to the readme or other docs how to install the bot + placeholder: https://github.com/nextcloud/call_summary_bot#readme + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 43e26c1cc..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -name: 🐞 Bug report -about: Help us to improve by reporting a bug -labels: 0. Needs triage, bug ---- - - - -### How to use GitHub - -* Please use the 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to show that you are affected by the same issue. -* Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue. -* Subscribe to receive notifications on status change and new comments. - ---- - -## Steps to reproduce -1. -2. -3. - -### Expected behaviour -Tell us what should happen - -### Actual behaviour -Tell us what happens instead - -## Talk app - -**Talk app version:** (see apps admin page: `/index.php/settings/apps`) - -**Custom Signaling server configured:** yes/no and version (see additional admin settings: `/index.php/index.php/settings/admin/talk#signaling_server`) - -**Custom TURN server configured:** yes/no (see additional admin settings: `/index.php/settings/admin/talk#turn_server`) - -**Custom STUN server configured:** yes/no (see additional admin settings: `/index.php/settings/admin/talk#stun_server`) - - -## Browser - -**Microphone available:** yes/no - -**Camera available:** yes/no - -**Operating system:** Windows/Ubuntu/... - -**Browser name:** Firefox/Chrome/... - -**Browser version:** 85/96/... - -### Browser log - -
-``` -Insert your browser log here, this could for example include: -a) The javascript console log -b) The network log -c) ... -``` - -
- -## Server configuration - - - -**Operating system**: Ubuntu/RedHat/... - -**Web server:** Apache/Nginx - -**Database:** MySQL/Maria/SQLite/PostgreSQL - -**PHP version:** 8.0/8.1/8.2 - -**Nextcloud Version:** (see admin page) - -**List of activated apps:** - -
- -``` -If you have access to your command line run e.g.: -sudo -u www-data php occ app:list -from within your server installation folder -``` -
- -**Nextcloud configuration:** - -
- -``` -If you have access to your command line run e.g.: -sudo -u www-data php occ config:list system -from within your Nextcloud installation folder -``` -
- -### Server log (data/nextcloud.log) -
- -``` -Insert your server log here -``` -
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index b8f2426c9..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: 🚀 Feature request -about: Suggest an idea for Nextcloud Talk -labels: 0. Needs triage, enhancement ---- - - - -### How to use GitHub - -* Please use the 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to show that you are interested into the same feature. -* Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue. -* Subscribe to receive notifications on status change and new comments. - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/README.md b/README.md index 3fe2cc5ef..3cd2577fc 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ If you have suggestions or problems, please [open an issue](https://github.com/n * **[📙 User documentation](https://docs.nextcloud.com/server/latest/user_manual/en/talk/index.html)** * **[💻 Server system requirements](https://nextcloud-talk.readthedocs.io/en/latest/system-requirements/)** * **[📗 Administration documentation](https://nextcloud-talk.readthedocs.io/en/latest/#administration-documentation)** +* **[🤖 Bots/Webhooks documentation](https://nextcloud-talk.readthedocs.io/en/latest/bots/)** * **[⚙️ API documentation](https://nextcloud-talk.readthedocs.io/en/latest/#talk-api)** ### 📦 Installing for Production -- cgit v1.2.3