Skip to content

Commit 61ad29a

Browse files
authored
Merge pull request #11291 from IQSS/7031-phoenix-schemaspy
Remove phoenix docs and scripts, update refs to SchemaSpy
2 parents 5fbfea2 + 431fe53 commit 61ad29a

File tree

13 files changed

+18
-113
lines changed

13 files changed

+18
-113
lines changed

doc/sphinx-guides/source/developers/making-releases.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,15 +331,19 @@ Deploy Final Release on Demo
331331

332332
Above you already did the hard work of deploying a release candidate to https://demo.dataverse.org. It should be relatively straightforward to undeploy the release candidate and deploy the final release.
333333

334+
.. _update-schemaspy:
335+
334336
Update SchemaSpy
335337
----------------
336338

337-
We maintain SchemaSpy at URLs like https://guides.dataverse.org/en/6.3/schemaspy/index.html
339+
We maintain SchemaSpy at URLs like https://guides.dataverse.org/en/latest/schemaspy/index.html and (for example) https://guides.dataverse.org/en/6.6/schemaspy/index.html
338340

339341
Get the attention of the core team and ask someone to update it for the new release.
340342

341343
Consider updating `the thread <https://groups.google.com/g/dataverse-community/c/f95DQU-wlVM/m/cvUp3E9OBgAJ>`_ on the mailing list once the update is in place.
342344

345+
See also :ref:`schemaspy`.
346+
343347
Alert Translators About the New Release
344348
---------------------------------------
345349

doc/sphinx-guides/source/developers/testing.rst

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -477,25 +477,6 @@ reduced anyway.
477477

478478
You will obviously have to utilize caching functionality of your CI service or do proper Docker layering.
479479

480-
The Phoenix Server
481-
~~~~~~~~~~~~~~~~~~
482-
483-
How the Phoenix Tests Work
484-
^^^^^^^^^^^^^^^^^^^^^^^^^^
485-
486-
A server at http://phoenix.dataverse.org has been set up to test the latest code from the develop branch. Testing is done using chained builds of Jenkins jobs:
487-
488-
- A war file is built from the latest code in develop: https://build.hmdc.harvard.edu:8443/job/phoenix.dataverse.org-build-develop/
489-
- The resulting war file is depoyed to the Phoenix server: https://build.hmdc.harvard.edu:8443/job/phoenix.dataverse.org-deploy-develop/
490-
- REST Assured Tests are run across the wire from the Jenkins server to the Phoenix server: https://build.hmdc.harvard.edu:8443/job/phoenix.dataverse.org-apitest-develop/
491-
492-
How to Run the Phoenix Tests
493-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
494-
495-
- Take a quick look at http://phoenix.dataverse.org to make sure the server is up and running Dataverse. If it's down, fix it.
496-
- Log into Jenkins and click "Build Now" at https://build.hmdc.harvard.edu:8443/job/phoenix.dataverse.org-build-develop/
497-
- Wait for all three chained Jenkins jobs to complete and note if they passed or failed. If you see a failure, open a GitHub issue or at least get the attention of some developers.
498-
499480
Accessibility Testing
500481
---------------------
501482

doc/sphinx-guides/source/developers/tips.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,14 +143,20 @@ pgAdmin
143143

144144
If you followed the :doc:`classic-dev-env` section, we had you install pgAdmin, which can help you explore the tables and execute SQL commands. It's also listed in the :doc:`tools` section.
145145

146+
.. _schemaspy:
147+
146148
SchemaSpy
147149
~~~~~~~~~
148150

149151
SchemaSpy is a tool that creates a website of entity-relationship diagrams based on your database.
150152

151-
We periodically run SchemaSpy and publish the output: https://guides.dataverse.org/en/6.2/schemaspy/index.html
153+
As part of our release process (:ref:`update-schemaspy`), we run SchemaSpy and publish the output at https://guides.dataverse.org/en/latest/schemaspy/index.html and (for example) https://guides.dataverse.org/en/6.6/schemaspy/index.html
154+
155+
To run SchemaSpy locally, you can try something like this (after downloading the jars from https://github.com/schemaspy/schemaspy/releases and https://jdbc.postgresql.org/download/):
156+
157+
``java -jar /tmp/schemaspy-6.2.4.jar -t pgsql -host localhost -db dvndb -u postgres -p secret -s public -dp /tmp/postgresql-42.7.5.jar -o /tmp/latest``
152158

153-
To run SchemaSpy locally, take a look at the syntax in ``scripts/deploy/phoenix.dataverse.org/post``.
159+
See also :ref:`db-name-creds`.
154160

155161
Deploying With ``asadmin``
156162
--------------------------
@@ -246,10 +252,9 @@ See also discussion of version numbers in :ref:`run-build-create-war`.
246252
Sample Data
247253
-----------
248254

249-
You may want to populate your **non-production** Dataverse installations with sample data. You have a couple options:
255+
You may want to populate your **non-production** Dataverse installations with sample data.
250256

251-
- Code in https://github.com/IQSS/dataverse-sample-data (recommended). This set of sample data includes several common data types, data subsetted from production datasets in dataverse.harvard.edu, datasets with file hierarchy, and more.
252-
- Scripts called from ``scripts/deploy/phoenix.dataverse.org/post``.
257+
https://github.com/IQSS/dataverse-sample-data includes several common data types, data subsetted from production datasets in dataverse.harvard.edu, datasets with file hierarchy, and more.
253258

254259
Switching from Glassfish to Payara
255260
----------------------------------

doc/sphinx-guides/source/installation/installation-main.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ Rerun Installer
196196

197197
With all the data cleared out, you should be ready to rerun the installer per above.
198198

199-
Related to all this is a series of scripts at https://github.com/IQSS/dataverse/blob/develop/scripts/deploy/phoenix.dataverse.org/deploy that Dataverse Project Team and Community developers use have the test server http://phoenix.dataverse.org rise from the ashes before integration tests are run against it. For more on this topic, see :ref:`rebuilding-dev-environment` section of the Developer Guide.
199+
For more on this topic, see :ref:`rebuilding-dev-environment` section of the Developer Guide.
200200

201201
Getting Support for Installation Trouble
202202
----------------------------------------

scripts/deploy/phoenix.dataverse.org/cert.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

scripts/deploy/phoenix.dataverse.org/deploy

Lines changed: 0 additions & 4 deletions
This file was deleted.

scripts/deploy/phoenix.dataverse.org/dv-root.json

Lines changed: 0 additions & 15 deletions
This file was deleted.

scripts/deploy/phoenix.dataverse.org/install

Lines changed: 0 additions & 19 deletions
This file was deleted.

scripts/deploy/phoenix.dataverse.org/post

Lines changed: 0 additions & 14 deletions
This file was deleted.

scripts/deploy/phoenix.dataverse.org/prep

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)