Skip to content

Commit

Permalink
Add Directory subsection to Plugin contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
vmdef committed Aug 10, 2023
1 parent e95e828 commit 654330b
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 12 deletions.
6 changes: 3 additions & 3 deletions data/migratedPages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion general/community/plugincontribution/guardians/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions general/community/plugincontribution/guardians/qaprechecks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [[email protected]](mailto:[email protected])

Expand All @@ -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.
Expand All @@ -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).
4 changes: 2 additions & 2 deletions general/community/plugincontribution/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
<figcaption>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Plugins directory API
sidebar_position: 10
sidebar_label: Directory API
sidebar_label: API
tags:
- Guidelines for contributors
- Plugins
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Plugins directory
sidebar_position: 7
tags:
- Guidelines for contributors
- Plugin documentation
Expand Down

0 comments on commit 654330b

Please sign in to comment.