Change site registration to opt-out

[Kristina Hoeppner]

It is difficult to know how many Mahara sites are there in the world. Since registration is opt-in, the majority of the sites are not sending basic data back to the project, which doesn't give us a good view of where Mahara is used and by how many people.

It would be good to gather better data about the use of Mahara in an anonymised way to help shape and focus the product and know what features are heavily used and which ones aren't. The current statistics don't necessarily give a useful picture to help us with that. Therefore, we should revise the registration data to collect more meaningful data and make it an opt-out rather than an opt-in. We would still keep data anonymised and aggregated to prevent collecting personal information.

We would exclude all sites that have the config variable 'productionmode = false' set so that we don't count sites twice or more when there is only one production site and several non-production sites. Whether the config variable can be read or whether that should be done differently, will need to be determined.

On sites with 'productionmode = false', we'd state on the page that this site is not reporting and don't show the form. We will mention though what happens when productionmode is turned to 'true' an that they can then opt out.

On mahara.org (customisation):

We will keep the weekly reporting and need to devise a mechanism to track that weekly data, e.g. available as CSV download because currently we only have a current view at https://mahara.org/stats/ (site admins only). The data does not need to sit on the site. The stats page does load very slowly because it's trying to fetch the data in real time it seems and the graph doesn't display any more any way. It is nice to have a quick view, but improving that page could be phase 2.

Apparently, we already keep historical data.

Run a cron early Monday morning to send the CSV file to a specified email address

Text on /admin/registersite.php:

Your Mahara site is registered with the Mahara project automatically. Registration is free and helps us get a picture of the Mahara installations around the world and how they are used.

The Mahara project does not collect personal, person-identifiable data. Most data is collected in aggregated form to allow the project to identify trends. Below you can see what data is collected and sent on a weekly basis.

If you have any questions for the data collection, please get in touch. ['get in touch' linked to <email address hidden> with the subject 'Site registration data collection')

Data included (see spreadsheet)

Opt-out from the data collection 'Yes/No' switch
Help text below: You can opt out from sending anonymised data to the Mahara project for your site. We encourage you to keep your site registered to assist the project in the product development.

Text on /admin/index.php:

Anonymised data from your site helps the Mahara project get a picture of Mahara installations around the world.

In the panel where it says 'Registration', change that to 'Data collection'.

Move elsewhere:

Move the plugin version numbers to their respective items in the 'Plugin administration'.

The spreadsheet contains:

- the fields to retain
- the fields to add
- the fields to move
- ideally the page can be split up into categories to group the information more easily when viewed on screen. In the CSV export, the categories should come as their own column for filtering purposes
- new column 'Enabled' where a 'Yes' or 'No' is placed depending on the setting in the configuration or for the artefact and block types if it is hidden or not. That way, we have context for any data for block types and artefacts when the values are '0'.

[Kristina Hoeppner (kris-hoeppner)]

Display on plugin admin

[Kristina Hoeppner (kris-hoeppner)]

Customisation for mahara.org

2 CSV files:

- historical data for a single site -> can be a download button on the details page
- current data for all sites as download button as well as cron to email

[Mahara Bot (dev-mahara)]

Patch for "main" branch: https://reviews.mahara.org/c/mahara/+/12884

[Mahara Bot (dev-mahara)]

Patch for "main" branch: https://reviews.mahara.org/c/mahara/+/12887

[Mahara Bot (dev-mahara)]

Reviewed: https://reviews.mahara.org/c/mahara/+/12883
Committed: https://git.mahara.org/mahara/mahara/commit/869b08bef1969b6ad1956a90f8ba2f90dd0eebab
Submitter: "Gold <email address hidden>"
Branch: main

commit 869b08bef1969b6ad1956a90f8ba2f90dd0eebab
Author: Robert Lyon <email address hidden>
Date: Tue Jun 14 13:13:28 2022 +1200

Bug 1978425: External -> Plugins page to show title / version

- Currently also displaying the old plugin string to help with title
diagnosis

- To change the title on a blocktype you need to add the
'get_plugin_display_name' function to the blocktype,

eg for watchlist you need to add

public static function get_plugin_display_name() {
return get_string('pluginname', 'blocktype.watchlist');
}

Inside the PluginBlocktypeWatchlist class

Change-Id: I33ea544d6cfee22b2e7fecb7fa99a485aea6a8f2
Signed-off-by: Robert Lyon <email address hidden>

[Mahara Bot (dev-mahara)]

Reviewed: https://reviews.mahara.org/c/mahara/+/12887
Committed: https://git.mahara.org/mahara/mahara/commit/df9ca7cab49454dea50114e6a316f21e0399b58d
Submitter: "Gold <email address hidden>"
Branch: main

commit df9ca7cab49454dea50114e6a316f21e0399b58d
Author: Robert Lyon <email address hidden>
Date: Wed Jun 15 19:47:31 2022 +1200

Bug 1978425: Adjust event log option 'masq' to 'masquerade'

To make things easier to read in registration data

Change-Id: Ibbdc7bc3e53f29712b571401de6b3ca1bd59463a
Signed-off-by: Robert Lyon <email address hidden>

[Mahara Bot (dev-mahara)]

Reviewed: https://reviews.mahara.org/c/mahara/+/12884
Committed: https://git.mahara.org/mahara/mahara/commit/2f5c6417b39e4a6c6cc593cfccefa916de64383d
Submitter: "Gold <email address hidden>"
Branch: main

commit 2f5c6417b39e4a6c6cc593cfccefa916de64383d
Author: Robert Lyon <email address hidden>
Date: Tue Jun 14 14:23:46 2022 +1200

Bug 1978425: Create categories for the registered data

For displaying better in Admin home -> Register

Also move the html generation out to a .tpl file

Change-Id: I3f908ebe610548f7dfea155bfd59c94a74845779
Signed-off-by: Robert Lyon <email address hidden>

[Mahara Bot (dev-mahara)]

Patch for "22.04_DEV" branch: https://reviews.mahara.org/c/mahara/+/13062

[Mahara Bot (dev-mahara)]

Patch for "22.04_DEV" branch: https://reviews.mahara.org/c/mahara/+/13063

[Mahara Bot (dev-mahara)]

Patch for "22.04_DEV" branch: https://reviews.mahara.org/c/mahara/+/13064

[Mahara Bot (dev-mahara)]

Patch for "21.10_DEV" branch: https://reviews.mahara.org/c/mahara/+/13065

[Mahara Bot (dev-mahara)]

Patch for "21.10_DEV" branch: https://reviews.mahara.org/c/mahara/+/13066

[Mahara Bot (dev-mahara)]

Patch for "21.10_DEV" branch: https://reviews.mahara.org/c/mahara/+/13067

[Mahara Bot (dev-mahara)]

Patch for "21.04_DEV" branch: https://reviews.mahara.org/c/mahara/+/13068

[Mahara Bot (dev-mahara)]

Patch for "21.04_DEV" branch: https://reviews.mahara.org/c/mahara/+/13069

[Mahara Bot (dev-mahara)]

Patch for "21.04_DEV" branch: https://reviews.mahara.org/c/mahara/+/13070

[Mahara Bot (dev-mahara)]

Reviewed: https://reviews.mahara.org/c/mahara/+/13062
Committed: https://git.mahara.org/mahara/mahara/commit/f6039629d3de86a364f339ae30d283806083d671
Submitter: "Robert Lyon <email address hidden>"
Branch: 22.04_DEV

commit f6039629d3de86a364f339ae30d283806083d671
Author: Robert Lyon <email address hidden>
Date: Tue Jun 14 13:13:28 2022 +1200

Bug 1978425: External -> Plugins page to show title / version

- Currently also displaying the old plugin string to help with title
diagnosis

- To change the title on a blocktype you need to add the
'get_plugin_display_name' function to the blocktype,

eg for watchlist you need to add

public static function get_plugin_display_name() {
return get_string('pluginname', 'blocktype.watchlist');
}

Inside the PluginBlocktypeWatchlist class

Change-Id: I33ea544d6cfee22b2e7fecb7fa99a485aea6a8f2
Signed-off-by: Robert Lyon <email address hidden>

[Mahara Bot (dev-mahara)]

Reviewed: https://reviews.mahara.org/c/mahara/+/13063
Committed: https://git.mahara.org/mahara/mahara/commit/fcbb97af361f069ef6873903b78ef3d86120a4c4
Submitter: "Robert Lyon <email address hidden>"
Branch: 22.04_DEV

commit fcbb97af361f069ef6873903b78ef3d86120a4c4
Author: Robert Lyon <email address hidden>
Date: Wed Jun 15 19:47:31 2022 +1200

Bug 1978425: Adjust event log option 'masq' to 'masquerade'

To make things easier to read in registration data

Change-Id: Ibbdc7bc3e53f29712b571401de6b3ca1bd59463a
Signed-off-by: Robert Lyon <email address hidden>

[Mahara Bot (dev-mahara)]

Reviewed: https://reviews.mahara.org/c/mahara/+/13064
Committed: https://git.mahara.org/mahara/mahara/commit/6904aa0ea6eb4261c92d21484239fdea574ec2da
Submitter: "Robert Lyon <email address hidden>"
Branch: 22.04_DEV

commit 6904aa0ea6eb4261c92d21484239fdea574ec2da
Author: Robert Lyon <email address hidden>
Date: Tue Jun 14 14:23:46 2022 +1200

Bug 1978425: Create categories for the registered data

For displaying better in Admin home -> Register

Also move the html generation out to a .tpl file

Change-Id: I3f908ebe610548f7dfea155bfd59c94a74845779
Signed-off-by: Robert Lyon <email address hidden>

[Mahara Bot (dev-mahara)]

Reviewed: https://reviews.mahara.org/c/mahara/+/13066
Committed: https://git.mahara.org/mahara/mahara/commit/c819851b3b6c3f97993e647b8e3d19cb1bcae23d
Submitter: "Robert Lyon <email address hidden>"
Branch: 21.10_DEV

commit c819851b3b6c3f97993e647b8e3d19cb1bcae23d
Author: Robert Lyon <email address hidden>
Date: Wed Jun 15 19:47:31 2022 +1200

Bug 1978425: Adjust event log option 'masq' to 'masquerade'

To make things easier to read in registration data

Change-Id: Ibbdc7bc3e53f29712b571401de6b3ca1bd59463a
Signed-off-by: Robert Lyon <email address hidden>

[Mahara Bot (dev-mahara)]

Reviewed: https://reviews.mahara.org/c/mahara/+/13067
Committed: https://git.mahara.org/mahara/mahara/commit/12016c00b4e99193101a002a71e9eb6d2b233847
Submitter: "Robert Lyon <email address hidden>"
Branch: 21.10_DEV

commit 12016c00b4e99193101a002a71e9eb6d2b233847
Author: Robert Lyon <email address hidden>
Date: Tue Jun 14 14:23:46 2022 +1200

Bug 1978425: Create categories for the registered data

For displaying better in Admin home -> Register

Also move the html generation out to a .tpl file

Change-Id: I3f908ebe610548f7dfea155bfd59c94a74845779
Signed-off-by: Robert Lyon <email address hidden>

[Mahara Bot (dev-mahara)]

Reviewed: https://reviews.mahara.org/c/mahara/+/13065
Committed: https://git.mahara.org/mahara/mahara/commit/6ef59892749a9f01df6292b3792cc8869860ea48
Submitter: "Robert Lyon <email address hidden>"
Branch: 21.10_DEV

commit 6ef59892749a9f01df6292b3792cc8869860ea48
Author: Robert Lyon <email address hidden>
Date: Tue Jun 14 13:13:28 2022 +1200

Bug 1978425: External -> Plugins page to show title / version

- Currently also displaying the old plugin string to help with title
diagnosis

- To change the title on a blocktype you need to add the
'get_plugin_display_name' function to the blocktype,

eg for watchlist you need to add

public static function get_plugin_display_name() {
return get_string('pluginname', 'blocktype.watchlist');
}

Inside the PluginBlocktypeWatchlist class

Change-Id: I33ea544d6cfee22b2e7fecb7fa99a485aea6a8f2
Signed-off-by: Robert Lyon <email address hidden>

[Mahara Bot (dev-mahara)]

Reviewed: https://reviews.mahara.org/c/mahara/+/13070
Committed: https://git.mahara.org/mahara/mahara/commit/e046e667c3e5e19a263c210127bce5e5eb01c70f
Submitter: "Robert Lyon <email address hidden>"
Branch: 21.04_DEV

commit e046e667c3e5e19a263c210127bce5e5eb01c70f
Author: Robert Lyon <email address hidden>
Date: Tue Jun 14 14:23:46 2022 +1200

Bug 1978425: Create categories for the registered data

For displaying better in Admin home -> Register

Also move the html generation out to a .tpl file

Change-Id: I3f908ebe610548f7dfea155bfd59c94a74845779
Signed-off-by: Robert Lyon <email address hidden>

[Mahara Bot (dev-mahara)]

Reviewed: https://reviews.mahara.org/c/mahara/+/13068
Committed: https://git.mahara.org/mahara/mahara/commit/825f87ee407ac28df1ca82240184037c6b9a8589
Submitter: "Robert Lyon <email address hidden>"
Branch: 21.04_DEV

commit 825f87ee407ac28df1ca82240184037c6b9a8589
Author: Robert Lyon <email address hidden>
Date: Tue Jun 14 13:13:28 2022 +1200

Bug 1978425: External -> Plugins page to show title / version

- Currently also displaying the old plugin string to help with title
diagnosis

- To change the title on a blocktype you need to add the
'get_plugin_display_name' function to the blocktype,

eg for watchlist you need to add

public static function get_plugin_display_name() {
return get_string('pluginname', 'blocktype.watchlist');
}

Inside the PluginBlocktypeWatchlist class

Change-Id: I33ea544d6cfee22b2e7fecb7fa99a485aea6a8f2
Signed-off-by: Robert Lyon <email address hidden>

[Mahara Bot (dev-mahara)]

Reviewed: https://reviews.mahara.org/c/mahara/+/13069
Committed: https://git.mahara.org/mahara/mahara/commit/457c2c671eb4587c6723d598d06647c3df3fbfff
Submitter: "Robert Lyon <email address hidden>"
Branch: 21.04_DEV

commit 457c2c671eb4587c6723d598d06647c3df3fbfff
Author: Robert Lyon <email address hidden>
Date: Wed Jun 15 19:47:31 2022 +1200

Bug 1978425: Adjust event log option 'masq' to 'masquerade'

To make things easier to read in registration data

Change-Id: Ibbdc7bc3e53f29712b571401de6b3ca1bd59463a
Signed-off-by: Robert Lyon <email address hidden>