diff --git a/data/migratedPages.yml b/data/migratedPages.yml index 18ebf9af9e..2dedb85d0a 100644 --- a/data/migratedPages.yml +++ b/data/migratedPages.yml @@ -1513,11 +1513,11 @@ Plugins_adoption_programme: - filePath: "/general/community/plugincontribution/adoption.md" slug: "/general/community/plugincontribution/adoption" Plugins_directory: -- filePath: "/general/community/plugincontribution/pluginsdirectory.md" +- filePath: "/general/community/plugincontribution/pluginsdirectory/index.md" slug: "/general/community/plugincontribution/pluginsdirectory" Plugins_directory_API: -- filePath: "/general/community/plugincontribution/pluginsdirectoryapi.md" - slug: "/general/community/plugincontribution/pluginsdirectoryapi" +- filePath: "/general/community/plugincontribution/pluginsdirectory/api.md" + slug: "/general/community/plugincontribution/pluginsdirectory/api" Plugins_guardians: - filePath: "/general/community/plugincontribution/guardians/index.md" slug: "/general/community/plugincontribution/guardians" diff --git a/general/community/plugincontribution/guardians/index.md b/general/community/plugincontribution/guardians/index.md index 2c2defc8f8..9591756b77 100644 --- a/general/community/plugincontribution/guardians/index.md +++ b/general/community/plugincontribution/guardians/index.md @@ -8,7 +8,7 @@ tags: --- ![thumb](./_index/plugins-guardian-logo.png) -**Plugins guardians** are Moodle community members who volunteer to provide peer-reviews on plugins submitted into the [Plugins directory](../../community/plugincontribution/pluginsdirectory). Their peer-review is considerably taken into account when deciding on the plugin approval. +**Plugins guardians** are Moodle community members who volunteer to provide peer-reviews on plugins submitted into the [Plugins directory](../../community/plugincontribution/pluginsdirectory/). Their peer-review is considerably taken into account when deciding on the plugin approval. ## Mission diff --git a/general/community/plugincontribution/guardians/qaprechecks.md b/general/community/plugincontribution/guardians/qaprechecks.md index 727c37ff52..a6f9a67020 100644 --- a/general/community/plugincontribution/guardians/qaprechecks.md +++ b/general/community/plugincontribution/guardians/qaprechecks.md @@ -7,7 +7,7 @@ tags: - Plugin documentation - QA --- -Plugin QA prechecks are for testing the functionality of plugins submitted for approval in the Moodle Plugins directory. Together with [code prechecks](../../community/plugincontribution/codeprechecks), they are part of the plugin [approval process](../../community/plugincontribution#sharing-code-in-the-plugins-directory). +Plugin QA prechecks are for testing the functionality of plugins submitted for approval in the Moodle Plugins directory. Together with [code prechecks](../../../community/plugincontribution/codeprechecks), they are part of the plugin [approval process](../../../community/plugincontribution#sharing-code-in-the-plugins-directory). Moodle community members with experience in setting up a local Moodle test environment can help with plugin QA prechecks. If you would like to help, please contact David Mudrák [david@moodle.com](mailto:david@moodle.com) @@ -22,7 +22,7 @@ In addition, if possible the site should run on the PostgreSQL database engine t ## Process -1. Choose a plugin needing an initial review from the [list of plugins awaiting approval](https://moodle.org/plugins/report/index.php?report=pendingapproval_plugins) (access restricted to members of the [Plugins guardians](../../community/plugincontribution/guardians) group). +1. Choose a plugin needing an initial review from the [list of plugins awaiting approval](https://moodle.org/plugins/report/index.php?report=pendingapproval_plugins) (access restricted to members of the [Plugins guardians](../../../community/plugincontribution/guardians/index.md) group). 1. To show that you are going to perform the QA prechecks, set yourself as the plugin approval issue assignee (CONTRIB-xxx as mentioned at the plugin page comments area). 1. Download and install it on your test site then perform the QA prechecks as listed below. 1. Add a comment to the plugin approval issue with your findings using the 'Plugin QA checklist' canned response. @@ -31,6 +31,6 @@ In addition, if possible the site should run on the PostgreSQL database engine t ## QA prechecks -1. Does the plugin have all the appropriate metadata as described in the [Plugin contribution checklist](../../community/plugincontribution/checklist)? +1. Does the plugin have all the appropriate metadata as described in the [Plugin contribution checklist](../../../community/plugincontribution/checklist)? 1. Does the plugin install nicely and not break or otherwise negatively affect the site functionality (anti-regression test)? This also checks that all eventual dependencies are already available in the plugins directory. 1. If possible (e.g. if no complex integration with an external system is needed), test the actual functionality of the plugin to see it works as described (feature test). diff --git a/general/community/plugincontribution/index.md b/general/community/plugincontribution/index.md index 411c78a1ae..0c8eeb28e8 100644 --- a/general/community/plugincontribution/index.md +++ b/general/community/plugincontribution/index.md @@ -5,7 +5,7 @@ tags: - Plugins - Plugin documentation --- -This page describes how to contribute your code into the [Plugins directory](../../community/plugincontribution/pluginsdirectory.md) to share it with the Moodle community. +This page describes how to contribute your code into the [Plugins directory](../../community/plugincontribution/pluginsdirectory/index.md) to share it with the Moodle community. ## Why @@ -38,7 +38,7 @@ Before submitting your work to the Plugins directory, you should make sure you h ## Sharing code in the Plugins directory -So you have written a new plugin and want to share it now in the [Plugins directory](../../community/plugincontribution/pluginsdirectory.md)? Great! Shortly, the workflow of publishing and maintaining your plugin in the Plugins directory looks like this: +So you have written a new plugin and want to share it now in the [Plugins directory](../../community/plugincontribution/pluginsdirectory/index.md)? Great! Shortly, the workflow of publishing and maintaining your plugin in the Plugins directory looks like this: ![Workflow of contributing a plugin into the Moodle plugins directory](_index/plugin-contribution-workflow.png)
diff --git a/general/community/plugincontribution/pluginsdirectoryapi.md b/general/community/plugincontribution/pluginsdirectory/api.md similarity index 99% rename from general/community/plugincontribution/pluginsdirectoryapi.md rename to general/community/plugincontribution/pluginsdirectory/api.md index 093f0f12e3..aaf3d61613 100644 --- a/general/community/plugincontribution/pluginsdirectoryapi.md +++ b/general/community/plugincontribution/pluginsdirectory/api.md @@ -1,7 +1,6 @@ --- title: Plugins directory API -sidebar_position: 10 -sidebar_label: Directory API +sidebar_label: API tags: - Guidelines for contributors - Plugins diff --git a/general/community/plugincontribution/pluginsdirectory.md b/general/community/plugincontribution/pluginsdirectory/index.md similarity index 96% rename from general/community/plugincontribution/pluginsdirectory.md rename to general/community/plugincontribution/pluginsdirectory/index.md index 668050aacb..94c8bacb7d 100644 --- a/general/community/plugincontribution/pluginsdirectory.md +++ b/general/community/plugincontribution/pluginsdirectory/index.md @@ -1,6 +1,5 @@ --- title: Plugins directory -sidebar_position: 7 tags: - Guidelines for contributors - Plugin documentation