From cea043b2226facac61b059b84f52dfa1e5131bfb Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Thu, 10 Mar 2022 17:02:22 -0500 Subject: [PATCH 1/2] stub out Signposting docs #8424 --- .../source/admin/discoverability.rst | 56 +++++++++++++++++++ doc/sphinx-guides/source/admin/index.rst | 1 + .../source/admin/integrations.rst | 9 +-- .../source/installation/config.rst | 9 +++ 4 files changed, 69 insertions(+), 6 deletions(-) create mode 100644 doc/sphinx-guides/source/admin/discoverability.rst diff --git a/doc/sphinx-guides/source/admin/discoverability.rst b/doc/sphinx-guides/source/admin/discoverability.rst new file mode 100644 index 00000000000..57a8f65a9e0 --- /dev/null +++ b/doc/sphinx-guides/source/admin/discoverability.rst @@ -0,0 +1,56 @@ +Discoverability +=============== + +Datasets are made discoverable by a variety of methods. + +.. contents:: |toctitle| + :local: + +DataCite Integration +-------------------- + +If you are using `DataCite `_ 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 datasets 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 `_, 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) ```` tags such as the following:: + + {"@context":"http://schema.org","@type":"Dataset","@id":"https://doi.org/... + + +Signposting +----------- + +The Dataverse Software supports technology called `Signposting `_ that allows machines to request more information about a dataset through the `Link `_ 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. diff --git a/doc/sphinx-guides/source/admin/index.rst b/doc/sphinx-guides/source/admin/index.rst index b97d9161d50..9390ae5ad11 100755 --- a/doc/sphinx-guides/source/admin/index.rst +++ b/doc/sphinx-guides/source/admin/index.rst @@ -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 diff --git a/doc/sphinx-guides/source/admin/integrations.rst b/doc/sphinx-guides/source/admin/integrations.rst index 3fc19716d53..671058921bf 100644 --- a/doc/sphinx-guides/source/admin/integrations.rst +++ b/doc/sphinx-guides/source/admin/integrations.rst @@ -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 `_ for details. +.. _integrations-discovery: + Discoverability --------------- -Integration with `DataCite `_ 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 +++++ diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst index 0a52a8a2fef..86aa32a920e 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -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`` From addf5cfec8668eafa7e708d167e16d2d59241b97 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Fri, 11 Mar 2022 14:41:36 -0500 Subject: [PATCH 2/2] emphasize that it's the metadata that gets harvested #8424 --- doc/sphinx-guides/source/admin/discoverability.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/admin/discoverability.rst b/doc/sphinx-guides/source/admin/discoverability.rst index 57a8f65a9e0..795e3dc629b 100644 --- a/doc/sphinx-guides/source/admin/discoverability.rst +++ b/doc/sphinx-guides/source/admin/discoverability.rst @@ -14,7 +14,7 @@ If you are using `DataCite `_ as your DOI provider, when d 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. +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 --------------------------------------------------