WIP: Support for subplugins

.github/workflows/moodle-ci.yml

@@ -8,8 +8,8 @@ jobs:
 
     strategy:
       matrix:
-        php: ['8.1']
-        moodle-branch: ['MOODLE_403_STABLE']
+        php: ['8.3']
+        moodle-branch: ['MOODLE_404_STABLE']
         database: ['pgsql']
 
     steps:
@@ -59,6 +59,18 @@ jobs:
       - name: Install mod plugin
         run: moodle-plugin-ci add-plugin learnweb/moodle-mod_moodleoverflow
 
+      - name: Install local plugin
+        run: moodle-plugin-ci add-plugin learnweb/moodle-local_townsquaresupport
+
+      - name: Install townsquareexpansion plugin
+        run: moodle-plugin-ci add-plugin learnweb/moodle-townsquareexpansion_moodleoverflow
+
+      - name: Install townsquareexpansion plugin
+        run: moodle-plugin-ci add-plugin learnweb/moodle-townsquareexpansion_ratingallocate
+
+      - name: Install townsquareexpansion plugin
+        run: moodle-plugin-ci add-plugin learnweb/moodle-townsquareexpansion_zoom
+
       - name: Install moodle-plugin-ci
         run: |
           moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1 --no-init
@@ -113,9 +125,27 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['8.0', '8.1']
-        moodle-branch: ['MOODLE_401_STABLE', 'MOODLE_402_STABLE', 'MOODLE_403_STABLE']
-        database: ['mariadb', 'pgsql']
+        php: [ '8.0', '8.1', '8.2', '8.3' ]
+        moodle-branch: [ 'MOODLE_401_STABLE', 'MOODLE_402_STABLE', 'MOODLE_403_STABLE', 'MOODLE_404_STABLE' ]
+        database: [ 'mariadb', 'pgsql' ]
+        exclude:
+          - php: '8.0'
+            moodle-branch: 'MOODLE_404_STABLE'
+          - php: '8.2'
+            moodle-branch: 'MOODLE_401_STABLE'
+          - php: '8.3'
+            moodle-branch: 'MOODLE_401_STABLE'
+          - php: '8.3'
+            moodle-branch: 'MOODLE_402_STABLE'
+          - php: '8.3'
+            moodle-branch: 'MOODLE_403_STABLE'
+        include:
+          - php: '7.4'
+            moodle-branch: 'MOODLE_401_STABLE'
+            database: 'pgsql'
+          - php: '7.4'
+            moodle-branch: 'MOODLE_401_STABLE'
+            database: 'mariadb'
 
     steps:
       - name: Start MariaDB

README.md

@@ -1,6 +1,22 @@
 # Town Square #
 
-A moodle block for the dashboard.This Plugin shows current events and forum posts in courses the user is enrolled to.
+A moodle block for the dashboard. This Plugin shows current events and forum posts in courses the user is enrolled.
+
+## Description ##
+
+The Goal of this plugin is to implement a block, where the different notifications (e.g. deadlines), activity completion and forum posts
+from different courses are shown. Additionally, the user is able to filter the notifications by different parameters.
+
+## Subplugin functionality ##
+
+Townsquare does not show notifications from every installed plugin, as every plugin can have different types of notifications that
+not always should be shown to the current user (e.g. a teacher should not see the same notifications as a student).
+Therefore, only the Moodle core plugins are supported by the plugin.
+To show notifications from other plugins, a subplugin can be implemented or installed. To do that, install the local plugin
+local_townsquaresupport (see: https://github.com/learnweb/moodle-local_townsquaresupport). Townsquaresupport manages
+subplugins and makes them available to Townsquare.
+
+More information on townsquare subplugins: https://github.com/learnweb/moodle-local_townsquaresupport/wiki
 
 ## Installing via uploaded ZIP file ##