Skip to content

Commit 4af01e0

Browse files
committed
add debug exporter, remove most refs to dataverse-exporters #10341
1 parent a8e0edf commit 4af01e0

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

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

+6-3
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,11 @@ Dataverse instances.
1515
As of v5.14, Dataverse provides a mechanism for third-party developers to create new metadata Exporters than implement
1616
new metadata formats or that replace existing formats. All the necessary dependencies are packaged in an interface JAR file
1717
available from Maven Central. Developers can distribute their new Exporters as JAR files which can be dynamically loaded
18-
into Dataverse instances - see :ref:`external-exporters`. Developers are encouraged to make their Exporter code available
19-
via https://github.com/gdcc/dataverse-exporters (or minimally, to list their existence in the README there).
18+
into Dataverse instances - see :ref:`external-exporters`. Developers are encouraged to work with the core Dataverse team
19+
(see :ref:`getting-help-developers`) to distribute these JAR files via Maven Central. See the
20+
`Croissant <https://central.sonatype.com/artifact/io.gdcc.export/croissant>`_ and
21+
`Debug <https://central.sonatype.com/artifact/io.gdcc.export/debug>`_ artifacts as examples. You may find other examples
22+
under :ref:`inventory-of-external-exporters` in the Installation Guide.
2023

2124
Exporter Basics
2225
---------------
@@ -63,7 +66,7 @@ If an Exporter cannot create a requested metadata format for some reason, it sho
6366
Building an Exporter
6467
--------------------
6568

66-
The example at https://github.com/gdcc/dataverse-exporters provides a Maven pom.xml file suitable for building an Exporter JAR file and that repository provides additional development guidance.
69+
The examples at https://github.com/gdcc/exporter-croissant and https://github.com/gdcc/exporter-debug provide a Maven pom.xml file suitable for building an Exporter JAR file and those repositories provide additional development guidance.
6770

6871
There are four dependencies needed to build an Exporter:
6972

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

+14
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,20 @@ The Maven Central landing page can be found at https://central.sonatype.com/arti
152152

153153
The source code and additional information can be found at https://github.com/gdcc/exporter-croissant where you are welcome to open issues and create pull requests.
154154

155+
Debug (``debug``)
156+
~~~~~~~~~~~~~~~~~
157+
158+
The "Debug" exporter is intended to help developers of future external exporters. It produces a JSON file that contains all available formats that are available to exporter authors such as datasetJson, datasetORE, datasetSchemaDotOrg, etc.
159+
160+
You can download the Debug exporter JAR from the following locations:
161+
162+
- released/stable: https://repo1.maven.org/maven2/io/gdcc/export/debug/
163+
- unreleased/snapshot: https://s01.oss.sonatype.org/content/groups/staging/io/gdcc/export/debug/
164+
165+
The Maven Central landing page can be found at https://central.sonatype.com/artifact/io.gdcc.export/debug
166+
167+
The source code and additional information can be found at https://github.com/gdcc/exporter-debug where you are welcome to open issues and create pull requests.
168+
155169
MyJSON (``dataverse_json``)
156170
~~~~~~~~~~~~~~~~~~~~~~~~~~~
157171

0 commit comments

Comments
 (0)