From ad3c4b83ecaaa3d59c7f3d384cbe04b8dab58b03 Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Mon, 2 Aug 2021 22:12:29 +0200 Subject: [PATCH 1/5] Update add_plugin.md --- .github/ISSUE_TEMPLATE/add_plugin.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/add_plugin.md b/.github/ISSUE_TEMPLATE/add_plugin.md index 13d6bff6..a077736f 100644 --- a/.github/ISSUE_TEMPLATE/add_plugin.md +++ b/.github/ISSUE_TEMPLATE/add_plugin.md @@ -18,36 +18,34 @@ A brief description what your plugin does. Consider including screenshots to hel #### Review commit ## Checklist **Product requirements** - [ ] The plugin is published under an [Open Source license](https://opensource.org/licenses/alphabetical). -- [ ] The source code is available in a public git repository. +- [ ] The source code is available in a public Git repository. - [ ] There is a public issue or bug tracker for the plugin, which is linked in the plugin documentation and linked via `support_url` in the manifest. - [ ] The plugin provides detailed usage documentation with at least one screenshot of the plugin in action, list of features, and a development guide. This is typically a `README` file or a landing page on the web. The link to the documentation is set as `homepage_url` in the manifest. A great example is the [`README` of the GitHub plugin](https://github.com/mattermost/mattermost-plugin-github/blob/master/README.md). - [ ] For the current release and upcoming ones a changelog has to be published, with a link recorded in the `release_notes_url` property of the `plugin.json` manifest. - [ ] The plugin has to be out of Beta and be released with at least v1.0.0. -- [ ] All configuration is accessible via the Mattermost UI. -- [ ] The plugin ID defined in the manifest must not collide with the ID of an existing plugin in the Marketplace. It should follow [the documentation's suggested naming convention](https://developers.mattermost.com/extend/plugins/manifest-reference/#id). +- [ ] All configuration is accessible via the Mattermost interface. +- [ ] The plugin ID defined in the manifest must not collide with the ID of an existing plugin in the Plugin Marketplace. It should follow [the documentation's suggested naming convention](https://developers.mattermost.com/extend/plugins/manifest-reference/#id). **Technical requirements** -- [ ] The plugin works for 60k concurrent connections and in a high-availability deployment. **Note:** There are currently no publicly-available tools to verify these properties. As such, they are checked during code review by a developer. +- [ ] The plugin works for 60k concurrent connections and in a High Availability deployment. **Note:** There are currently no publicly-available tools to verify these properties. As such, they are checked during code review by a developer. - [ ] The plugin logs important events on appropriate log levels to allow System Admins to troubleshoot issues. **Security requirements** From 1a844a66a03fe883e5777a09186fdfbd361dc142 Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Thu, 2 Sep 2021 17:39:20 +0200 Subject: [PATCH 2/5] Update add_plugin.md --- .github/ISSUE_TEMPLATE/add_plugin.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/add_plugin.md b/.github/ISSUE_TEMPLATE/add_plugin.md index a077736f..8d55228d 100644 --- a/.github/ISSUE_TEMPLATE/add_plugin.md +++ b/.github/ISSUE_TEMPLATE/add_plugin.md @@ -24,11 +24,8 @@ Please link to an open source repository and release that should be used for rev ## Checklist @@ -41,7 +38,7 @@ If your plugin isn't production-ready, please leave a comment stating whether yo - [ ] For the current release and upcoming ones a changelog has to be published, with a link recorded in the `release_notes_url` property of the `plugin.json` manifest. - [ ] The plugin has to be out of Beta and be released with at least v1.0.0. - [ ] All configuration is accessible via the Mattermost interface. -- [ ] The plugin ID defined in the manifest must not collide with the ID of an existing plugin in the Plugin Marketplace. It should follow [the documentation's suggested naming convention](https://developers.mattermost.com/extend/plugins/manifest-reference/#id). +- [ ] The plugin ID defined in the manifest must not collide with the ID of an existing plugin in the Marketplace. It should follow [the documentation's suggested naming convention](https://developers.mattermost.com/extend/plugins/manifest-reference/#id). **Technical requirements** From 5f3b0276e3c6db9024f340db3103bfcbd36cb602 Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Thu, 2 Sep 2021 17:48:03 +0200 Subject: [PATCH 3/5] Update add_plugin.md --- .github/ISSUE_TEMPLATE/add_plugin.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/add_plugin.md b/.github/ISSUE_TEMPLATE/add_plugin.md index 8d55228d..07a2715a 100644 --- a/.github/ISSUE_TEMPLATE/add_plugin.md +++ b/.github/ISSUE_TEMPLATE/add_plugin.md @@ -34,7 +34,6 @@ If your plugin isn't production-ready, please leave a comment stating whether yo - [ ] The plugin is published under an [Open Source license](https://opensource.org/licenses/alphabetical). - [ ] The source code is available in a public Git repository. - [ ] There is a public issue or bug tracker for the plugin, which is linked in the plugin documentation and linked via `support_url` in the manifest. -- [ ] The plugin provides detailed usage documentation with at least one screenshot of the plugin in action, list of features, and a development guide. This is typically a `README` file or a landing page on the web. The link to the documentation is set as `homepage_url` in the manifest. A great example is the [`README` of the GitHub plugin](https://github.com/mattermost/mattermost-plugin-github/blob/master/README.md). - [ ] For the current release and upcoming ones a changelog has to be published, with a link recorded in the `release_notes_url` property of the `plugin.json` manifest. - [ ] The plugin has to be out of Beta and be released with at least v1.0.0. - [ ] All configuration is accessible via the Mattermost interface. @@ -54,3 +53,15 @@ If your plugin isn't production-ready, please leave a comment stating whether yo - [ ] The plugin must set a `min_server_version` in the manifest. - [ ] The plugin must work on all Mattermost versions greater than or equal to the `min_server_version`. + +**Documentation requirements (checked by a Technical Writer)** + +- [ ] The plugin must include detailed usage documentation with at least one screenshot of the plugin in action, list of features, and a development guide. This is typically a `README` file or a landing page on the web. The link to the documentation is set as `homepage_url` in the manifest. A great example is the [`README` of the GitHub plugin](https://github.com/mattermost/mattermost-plugin-github/blob/master/README.md). Typical components of documentation include: + + * Requirements/Prerequisites + * Installation steps + * Configuration steps + * Usage + * Troubleshooting + * Screenshots (if available) + * Link or email address for help/support From 1b140fd0f89e2394eee068ea68a47454c3426400 Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Wed, 26 Jan 2022 16:37:40 +0200 Subject: [PATCH 4/5] Update add_plugin.md --- .github/ISSUE_TEMPLATE/add_plugin.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/add_plugin.md b/.github/ISSUE_TEMPLATE/add_plugin.md index 07a2715a..1293afda 100644 --- a/.github/ISSUE_TEMPLATE/add_plugin.md +++ b/.github/ISSUE_TEMPLATE/add_plugin.md @@ -23,9 +23,12 @@ Please link to an open source repository and release that should be used for rev ## Checklist From eba7a022dbf069d91692fa6daf74f974c9586898 Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Wed, 26 Jan 2022 16:38:25 +0200 Subject: [PATCH 5/5] Update add_plugin.md --- .github/ISSUE_TEMPLATE/add_plugin.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/add_plugin.md b/.github/ISSUE_TEMPLATE/add_plugin.md index 1293afda..bdf675e6 100644 --- a/.github/ISSUE_TEMPLATE/add_plugin.md +++ b/.github/ISSUE_TEMPLATE/add_plugin.md @@ -68,3 +68,5 @@ If your plugin isn't production-ready, please leave a comment stating whether yo * Troubleshooting * Screenshots (if available) * Link or email address for help/support + +The `plugin.json` file should include formatting consistent with the System Console interface. You can join the [Documentation channel](https://community.mattermost.com/core/channels/documentation) for assistance.