search

IQSS / dataverse

Open source research data repository software
http://dataverse.org
Other
875 stars 484 forks source link

Hosting for SchemaSpy (currently hosted on phoenix.dataverse.org) #7031

Open pdurbin opened 4 years ago

pdurbin commented 4 years ago

Long ago I configured http://phoenix.dataverse.org/schemaspy/latest/index.html to host schema information about the Dataverse database. I often link to this site when helping people understand something about the database. I also wrote it up in the dev guide at http://guides.dataverse.org/en/4.20/developers/tips.html#schemaspy

Screen Shot 2020-06-26 at 4 11 37 PM

The phoenix server is being shut down at some point so we need to find alternative hosting for these docs.

As indicated in the screenshot above, the script to build the SchemaSpy docs can be found at https://github.com/IQSS/dataverse/blob/v4.20/scripts/deploy/phoenix.dataverse.org/post#L15 . It's a oneliner: java -jar downloads/schemaSpy_5.0.0.jar -t pgsql -host localhost -db dvndb -u postgres -p secret -s public -dp scripts/installer/pgdriver/postgresql-42.2.9.jar -o /var/www/html/schemaspy/latest

donsizemore commented 4 years ago

@pdurbin Permanent web-hosting would be great, but this strikes me as an excellent workflow to Dockerize.

pdurbin commented 3 years ago

People seem to like the SchemaSpy diagrams. @BPeuch just said, "Wow, that ER diagram of Dataverse's database rocks, Philip! Thanks for posting it."

One thing I didn't mention when I opened this issue is that builds are no longer happening on the phoenix server so the diagrams hosted there are increasing out of date as the database evolves.

BPeuch commented 3 years ago

That's good to know, @pdurbin. Thanks for tagging me. We hope an alternative representation system can be found.

donsizemore commented 3 years ago

@pdurbin if it just needs to live somewhere, how about off the root of guides.dataverse.org?

donsizemore commented 3 years ago

@BPeuch I generated this today from a Dataverse 5.4 DB, if you'd like to take a look: https://guides.dataverse.org/en/5.4/schemaspy/

djbrooke commented 3 years ago

Thanks @donsizemore, this is great. I talked with @pdurbin about this a little while ago and he confirmed to me it was most important to have it for a specific version - I was thinking that it needed to be provided on demand for any branches in progress but he said this isn't usually the case. I think if it could be included on the guides server I think it'd be great, thanks for adding it for 5.4!

pdurbin commented 3 years ago

Yeah, @donsizemore and I were discussing this yesterday and I've very happy that once again there is a publicly accessible version of the schemaspy output (I had built my own local version for now). Thanks, Don!

BPeuch commented 3 years ago

Oh this is very practical! Thanks a lot @donsizemore!

I like the network (ER) model, but this is also very handy, especially the neat presentation of columns with the sorting out of IDs and other such categories. :wrench:

pdurbin commented 10 months ago

@donsizemore published a version for 5.14: https://guides.dataverse.org/en/5.14/schemaspy/

Thank you, Don!

See also https://groups.google.com/g/dataverse-community/c/f95DQU-wlVM/m/9HcRbaSVBQAJ

poikilotherm commented 10 months ago

This reminds me of https://blog.esciencecenter.nl/versioned-documentation-using-only-github-actions-and-github-pages-1825296e31aa and how we could add such a thing to not just host our guides on Pages, but also include OpenAPI docs, SchemaSpy, JSON Schemas etc etc etc.

cmbz commented 3 weeks ago

To focus on the most important features and bugs, we are closing issues created before 2020 (version 5.0) that are not new feature requests with the label 'Type: Feature'.

If you created this issue and you feel the team should revisit this decision, please reopen the issue and leave a comment.

pdurbin commented 3 weeks ago

Yes, I still think we should give our valuable SchemaSpy information a good home, so I'll reopen this. I guess I'll give it a size of 10 but that's a guess.

pdurbin commented 3 weeks ago

@donsizemore published a version for 5.14: https://guides.dataverse.org/en/5.14/schemaspy/

I'd be remiss if I didn't point out that @donsizemore continues to publish SchemaSpy data to the guides server (thank you!) from time to time.

He doesn't publish for every release (the latest was https://guides.dataverse.org/en/6.2/schemaspy/index.html I believe) but I always try to let the community know.

Should we continue with publishing SchemaSpy to the guides server? If so, perhaps we could add a manual step for now to a future versions of our making releases doc. Then automate it?

@donsizemore what do you think?

donsizemore commented 3 weeks ago

@donsizemore it's easy to do and I'm happy to do it; it's part of the Dataverse-Ansible run but not automated to push to guides.dataverse.org. I just zip it up and copy it over when I remember to.