Skip to content

stub out Signposting docs #8424 #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pdurbin wants to merge 2 commits into
base: signposting-5.9
Choose a base branch
from
Open

stub out Signposting docs #8424 #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cea043b
stub out Signposting docs #8424
pdurbin Mar 10, 2022
addf5cf
emphasize that it's the metadata that gets harvested #8424
pdurbin Mar 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions doc/sphinx-guides/source/admin/discoverability.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
Discoverability
===============

Datasets are made discoverable by a variety of methods.

.. contents:: |toctitle|
:local:

DataCite Integration
--------------------

If you are using `DataCite <https://datacite.org>`_ as your DOI provider, when datasets are published, metadata is pushed to DataCite, where it can be searched. For more information, see :ref:`:DoiProvider` in the Installation Guide.

OAI-PMH (Harvesting)
--------------------

The Dataverse Software supports a protocol called OAI-PMH that facilitates harvesting dataset metadata from one system into another. For details on harvesting, see the :doc:`harvestserver` section.

Machine-Readable Metadata on Dataset Landing Pages
--------------------------------------------------

As recommended in `A Data Citation Roadmap for Scholarly Data Repositories <https://doi.org/10.1101/097196>`_, the Dataverse Software embeds metadata on dataset landing pages in a variety of machine-readable ways.

Dublin Core HTML Meta Tags
++++++++++++++++++++++++++

The HTML source of a dataset landing page includes "DC" (Dublin Core) ``<meta>`` tags such as the following::

<meta name="DC.identifier" content="..."
<meta name="DC.type" content="Dataset"
<meta name="DC.title" content="..."

https://github.com/IQSS/dataverse/pull/3828

Schema.org JSON-LD Metadata
+++++++++++++++++++++++++++

The HTML source of a dataset landing page includes Schema.org JSON-LD metadata like this::


<script type="application/ld+json">{"@context":"http://schema.org","@type":"Dataset","@id":"https://doi.org/...


Signposting
-----------

The Dataverse Software supports technology called `Signposting <https://signposting.org>`_ that allows machines to request more information about a dataset through the `Link <https://tools.ietf.org/html/rfc5988>`_ HTTP header.

The following configuration options are available:

- :ref:`:SignpostingMaxItems`

Additional Discoverability Through Integrations
-----------------------------------------------

See :ref:`integrations-discovery` in the Integrations section for additional discovery methods you can enable.
1 change: 1 addition & 0 deletions doc/sphinx-guides/source/admin/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ This guide documents the functionality only available to superusers (such as "da
integrations
user-administration
dataverses-datasets
discoverability
solr-search-index
ip-groups
mail-groups
Expand Down
9 changes: 3 additions & 6 deletions doc/sphinx-guides/source/admin/integrations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,15 +134,12 @@ Avgidea Data Search

Researchers can use a Google Sheets add-on to search for Dataverse installation's CSV data and then import that data into a sheet. See `Avgidea Data Search <https://www.avgidea.io/avgidea-data-platform.html>`_ for details.

.. _integrations-discovery:

Discoverability
---------------

Integration with `DataCite <https://datacite.org>`_ is built in to the Dataverse Software. When datasets are published, metadata is sent to DataCite. You can further increase the discoverability of your datasets by setting up additional integrations.

OAI-PMH (Harvesting)
++++++++++++++++++++

The Dataverse Software supports a protocol called OAI-PMH that facilitates harvesting datasets from one system into another. For details on harvesting, see the :doc:`harvestserver` section.
A number of builtin features related to data discovery are listed under :doc:`discoverability` but you can further increase the discoverability of your data by setting up integrations.

SHARE
+++++
Expand Down
9 changes: 9 additions & 0 deletions doc/sphinx-guides/source/installation/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2524,3 +2524,12 @@ For example:
++++++++++++++++++++++++++++++++

When set to ``true``, this setting allows a superuser to publish and/or update Dataverse collections and datasets bypassing the external validation checks (specified by the settings above). In an event where an external script is reporting validation failures that appear to be in error, this option gives an admin with superuser privileges a quick way to publish the dataset or update a collection for the user.

.. _:SignPostingMaxItems:

:SignpostingMaxItems
++++++++++++++++++++

Limits the number of items shown.

``curl -X PUT -d 5 http://localhost:8080/api/admin/settings/:SignpostingMaxItems``