SchemaSpy Integration

[Josh Stompro]

EG 3.11+

Add some support for generating database schema documentation with SchemaSpy.

There was a discussion on the documentation listserve after Blake mentioned SchemaSpy.
http://list.evergreen-ils.org/pipermail/evergreen-documentation/2024-April/000196.html

https://schemaspy.org/

Koha and Aspen make use of SchemaSpy for documentation for some examples.
https://schema.koha-community.org/
https://github.com/Aspen-Discovery/aspen-schemaspy
https://aspen-discovery.github.io/aspen-schemaspy/

I thought I might start with making it easy to generate SchemaSpy docs for a stand alone install of Evergreen.

Install SchemaSpy + prerequisites like other Evergreen prerequisites are installed.
sudo make -f Makefile.install debian-bullseye-schemaspy

Then generate and install the html with a helper script that grabs the current DB connection info from opensrf.xml and puts the files at https://evergreensite.host/docs/schemaspy for easy access.

Once that is in place, it may simplify the automation of building official SchemaSpy docs for the official documentation site.

For comparison - the old schema docs can be found at
https://wiki.evergreen-ils.org/doku.php?id=dev:database_schemas
https://wiki.evergreen-ils.org/doku.php?id=history:database_schemata_archive

[Josh Stompro (u-launchpad-stompro-org)]

Working Branch with one commit at

user/stompro/lp2065812_schemaspy_support

https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/stompro/lp2065812_schemaspy_support

So far just adds the bits to install SchemaSpy (Downloading the current release jar file) and installing the packages needed.

I've only tested on Debian 11 (Bullseye) so far.
Josh