Third-party plugins overview

Bug #1855630 reported by Rebecca Blundell
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Mahara
Fix Released
Wishlist
Rebecca Blundell

Bug Description

What was committed so far: List of third-party plugins that Mahara uses is visible in the admin menu.

Original:

Creating a map/library/index of Mahara components to know what things mean, what they connect to and how to find them.

Tags: newfeature
Changed in mahara:
assignee: nobody → Rebecca Blundell (rjb-dev)
Revision history for this message
Rebecca Blundell (rjb-dev) wrote :

I found a way to see the database links, which show which tables are connected and their relationships using some Open Source software called Schemaspy. http://schemaspy.org/ It saves the database state in a folder of html files which you can view in your browser.

How to use:

1. Download the latest Schemaspy jar from
https://github.com/schemaspy/schemaspy/releases/

2. Download the PostgreSQL JDBC driver for Java 8 (assuming you're running openJDK 8) from
https://jdbc.postgresql.org/download.html

3. Put both jars in a directory of your choosing and go to that directory.

4. Run the following command, changing details as necessary. (The list of commandline arguments for schemaspy is here: https://schemaspy.readthedocs.io/en/latest/configuration/commandline.html)
This command uses schemaspy to map a psql db called mahara-master and output results to a new directory called schemaspy. (This took around 7 mins).

java -jar schemaspy-6.1.0.jar -t pgsql -db mahara-master -host localhost -u maharauser -p maharapassword -o ./schemaspy -dp postgresql-42.2.9.jar -vizjs

Revision history for this message
Rebecca Blundell (rjb-dev) wrote :

I've been looking for a tool to map code into some kind of diagram of dependencies. There are several tools out there that claim to do this, but I have failed to run several of them, including Doxygen and mihaeu/dephpend. I got mamuz/phpda to run, but am abandoning this now as the output is patchy or non-existent for our code.

I'm going to look at a high-level manual map and if I can see a way of automating that data collection, I'll suggest developing it or look for a tool that can capture the useful data specifically

Changed in mahara:
status: New → In Progress
importance: Undecided → Medium
Revision history for this message
Kristina Hoeppner (kris-hoeppner) wrote :

We might have looked at phpDocumentor in the past (Aaron sees it as likely that it had been that program and it does look slightly familiar): https://www.phpdoc.org

"That's a PHP tool to extract documentation from "docblocks" like this in the source code:

/**
 * This file is part of phpDocumentor.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @link http://phpdoc.org
 */

"There may be other PHP programs to do that as well, or even generic cross-language programs, since the "docblock" pattern is common across several languages."

Revision history for this message
Mahara Bot (dev-mahara) wrote : A patch has been submitted for review

Patch for "master" branch: https://reviews.mahara.org/11101

Revision history for this message
Mahara Bot (dev-mahara) wrote :

Patch for "master" branch: https://reviews.mahara.org/11102

Revision history for this message
Mahara Bot (dev-mahara) wrote :

Patch for "master" branch: https://reviews.mahara.org/11103

Changed in mahara:
milestone: none → 20.10.0
importance: Medium → Wishlist
Changed in mahara:
milestone: 20.10.0 → 21.04.0
Changed in mahara:
milestone: 21.04.0 → 21.10.0
Revision history for this message
Mahara Bot (dev-mahara) wrote : A change has been merged

Reviewed: https://reviews.mahara.org/11101
Committed: https://git.mahara.org/mahara/mahara/commit/36031e76bac38e11880c8c34f6d840c71f4d5414
Submitter: Robert Lyon (<email address hidden>)
Branch: master

commit 36031e76bac38e11880c8c34f6d840c71f4d5414
Author: Rebecca Blundell <email address hidden>
Date: Mon Aug 3 15:33:28 2020 +1200

Bug 1855630: Mahara component map/library

- add Development option to admin menu
- add third party library as first component
The list is currently marked "show" on page load, as there is
only one component. It is collapsible as more components are
intended to be added.
@TODO add other components
- update some README.Mahara files to show correct 3rd party urls
- add csv download option for third party list
- langstrings as needed

Adjustments by Bob
- Changed to case insensitive ordering so DataTables appears after
csstidy and that all the 'fonts' ones are also sorted by path
- Adjusted the matching so README.Mahara and README.mahara are both
handled correctly
- Trim whitespace from csv fields

Change-Id: Ie3e47b03217ec8a786b0b0ddea8387faefbd6d1f

Revision history for this message
Mahara Bot (dev-mahara) wrote :

Reviewed: https://reviews.mahara.org/11102
Committed: https://git.mahara.org/mahara/mahara/commit/381fb3f8b0a11edcbbf9f8aa281ab78947bc7ce7
Submitter: Robert Lyon (<email address hidden>)
Branch: master

commit 381fb3f8b0a11edcbbf9f8aa281ab78947bc7ce7
Author: Rebecca Blundell <email address hidden>
Date: Mon Aug 3 16:19:03 2020 +1200

Bug 1855630: Add styleguide and behat steps to development menu

- Make the styleguide and behat steps accessible from a menu
- langstrings as required

Change-Id: Id8a163a24266ddcd02cec11ee5193b55cf86496f

summary: - Mahara map: an index of components
+ Third-party plugins overview
description: updated
tags: added: newfeature
Revision history for this message
Robert Lyon (robertl-9) wrote :

Have calved off the third part of this bug to it's own bug https://bugs.launchpad.net/mahara/+bug/1945528

Changed in mahara:
status: In Progress → Fix Committed
Robert Lyon (robertl-9)
Changed in mahara:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers