Skip to content

Commit

Permalink
remove inventory of exporters, link to README instead IQSS#10341
Browse files Browse the repository at this point in the history
  • Loading branch information
pdurbin committed Jul 9, 2024
1 parent 10f03b5 commit b5e7401
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 30 deletions.
2 changes: 1 addition & 1 deletion doc/release-notes/10341-croissant.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ A new metadata export format called Croissant is now available as an external me

When enabled, Croissant replaces the Schema.org JSON-LD format in the `<head>` of dataset landing pages. For details, see the [Schema.org JSON-LD/Croissant Metadata](https://dataverse-guide--10533.org.readthedocs.build/en/10533/admin/discoverability.html#schema-org-head) under the discoverability section of the Admin Guide.

For more about the Croissant exporter, see https://github.com/gdcc/exporter-croissant and the [writeup](https://dataverse-guide--10533.org.readthedocs.build/en/10533/installation/advanced.html#croissant-croissant) in the guides.
For more about the Croissant exporter, see https://github.com/gdcc/exporter-croissant

For installation instructions, see [Enabling External Exporters](https://dataverse-guide--10533.org.readthedocs.build/en/10533/installation/advanced.html#enabling-external-exporters) in the Installation Guide.

Expand Down
30 changes: 1 addition & 29 deletions doc/sphinx-guides/source/installation/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,35 +136,7 @@ Use the :ref:`dataverse.spi.exporters.directory` configuration option to specify
Inventory of External Exporters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In the list below, the name of each exporter is followed by the machine-readable name in parentheses for use in APIs (see :ref:`export-dataset-metadata-api` in the API Guide).

Croissant (``croissant``)
~~~~~~~~~~~~~~~~~~~~~~~~~

`Croissant <https://github.com/mlcommons/croissant>`_ is oriented toward machine learning and exposes variable-level metadata. When enabled, it replaces the Schema.org JSON-LD shown in the ``<head>`` of a dataset page, as described under :ref:`schema.org-head` in the Admin Guide.

You can download the Croissant exporter JAR from the following locations:

- released/stable: https://repo1.maven.org/maven2/io/gdcc/export/croissant/
- unreleased/snapshot: https://s01.oss.sonatype.org/content/groups/staging/io/gdcc/export/croissant/

The Maven Central landing page can be found at https://central.sonatype.com/artifact/io.gdcc.export/croissant

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.

Debug (``debug``)
~~~~~~~~~~~~~~~~~

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.

You can download the Debug exporter JAR from the following locations:

- released/stable: https://repo1.maven.org/maven2/io/gdcc/export/debug/
- unreleased/snapshot: https://s01.oss.sonatype.org/content/groups/staging/io/gdcc/export/debug/

The Maven Central landing page can be found at https://central.sonatype.com/artifact/io.gdcc.export/debug

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.
For a list of external exporters, see the README at https://github.com/gdcc/dataverse-exporters

Developing New Exporters
^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit b5e7401

Please sign in to comment.