From 2c1e5df87f9c42bf44b67376356ac4b841558593 Mon Sep 17 00:00:00 2001 From: kuhlaid <41551429+kuhlaid@users.noreply.github.com> Date: Fri, 29 Jul 2022 11:55:19 -0400 Subject: [PATCH 01/10] Update layout.html Fixing broken link to Sphinx --- doc/sphinx_bootstrap_theme/bootstrap/layout.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx_bootstrap_theme/bootstrap/layout.html b/doc/sphinx_bootstrap_theme/bootstrap/layout.html index 9d17996292b..d3ccd463814 100755 --- a/doc/sphinx_bootstrap_theme/bootstrap/layout.html +++ b/doc/sphinx_bootstrap_theme/bootstrap/layout.html @@ -106,7 +106,7 @@ {%- if hasdoc('copyright') %} {% trans path=pathto('copyright'), copyright=copyright|e %}

Copyright © {{ copyright }}.

{% endtrans %} {%- else %} - {% trans copyright=copyright|e %}

Developed at the Institute for Quantitative Social Science  |  Code available at  |  Created using Sphinx {{ sphinx_version }}
Last updated on {{ last_updated }}  |  Dataverse v. {{ version }}  |  View the latest version of Dataverse Guides

+ {% trans copyright=copyright|e %}

Developed at the Institute for Quantitative Social Science  |  Code available at  |  Created using Sphinx {{ sphinx_version }}
Last updated on {{ last_updated }}  |  Dataverse v. {{ version }}  |  View the latest version of Dataverse Guides

Copyright © {{ copyright }}

{% endtrans %} {%- endif %} {%- endif %} From aed167bd7db866bd72fb0c17dd7931043b648e74 Mon Sep 17 00:00:00 2001 From: kuhlaid <41551429+kuhlaid@users.noreply.github.com> Date: Fri, 29 Jul 2022 12:25:38 -0400 Subject: [PATCH 02/10] Update docsdataverse_org.css Adding style to highlight current page in the menu --- doc/sphinx-guides/source/_static/docsdataverse_org.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/_static/docsdataverse_org.css b/doc/sphinx-guides/source/_static/docsdataverse_org.css index e4afe89e217..da4ba06ddd4 100755 --- a/doc/sphinx-guides/source/_static/docsdataverse_org.css +++ b/doc/sphinx-guides/source/_static/docsdataverse_org.css @@ -68,7 +68,7 @@ a.headerlink { #sidebar.bs-sidenav { background-color: #f8d5b8; } -#sidebar.bs-sidenav .nav > li > a:hover, #sidebar.bs-sidenav .nav > li > a:focus { +#sidebar.bs-sidenav .nav > li > a:hover, #sidebar.bs-sidenav .nav > li > a:focus, #sidebar.bs-sidenav .nav > li > a.current { background-color: #fbf4c5; border-right: 1px solid #dbd8e0; text-decoration: none; From 10bc4646bc9f52f557959fdda43c6a206d60d276 Mon Sep 17 00:00:00 2001 From: kuhlaid <41551429+kuhlaid@users.noreply.github.com> Date: Fri, 29 Jul 2022 13:30:20 -0400 Subject: [PATCH 03/10] Update dataset-semantic-metadata-api.rst Switching @context from a link to inline literal since this text should not link to anything --- .../source/developers/dataset-semantic-metadata-api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/developers/dataset-semantic-metadata-api.rst b/doc/sphinx-guides/source/developers/dataset-semantic-metadata-api.rst index 7abae535276..85a44da48c6 100644 --- a/doc/sphinx-guides/source/developers/dataset-semantic-metadata-api.rst +++ b/doc/sphinx-guides/source/developers/dataset-semantic-metadata-api.rst @@ -74,7 +74,7 @@ To delete metadata for a Dataset, send a json-ld representation of the fields to curl -X PUT -H X-Dataverse-key:$API_TOKEN -H 'Content-Type: application/ld+json' -d '{"https://dataverse.org/schema/core#restrictions":"No restrictions"}' "$SERVER_URL/api/datasets/:persistentId/metadata/delete?persistentId=$DATASET_PID" -Note, this example uses the term URI directly rather than adding an '@context' element. You can use either form in any of these API calls. +Note, this example uses the term URI directly rather than adding an ``@context`` element. You can use either form in any of these API calls. You should expect a 200 ("OK") response indicating whether a draft Dataset version was created or an existing draft was updated. From 0893d172f72e87803da00b183f4ad1d6da67b280 Mon Sep 17 00:00:00 2001 From: kuhlaid <41551429+kuhlaid@users.noreply.github.com> Date: Fri, 29 Jul 2022 17:07:32 -0400 Subject: [PATCH 04/10] Update native-api.rst Changing openprovenance.org to use the https (because the site seems to only be using HTTPS and the HTTP URL is not redirecting to the HTTPS URL and is breaking page) --- doc/sphinx-guides/source/api/native-api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/api/native-api.rst b/doc/sphinx-guides/source/api/native-api.rst index cbf9e6c9128..1f85ee02825 100644 --- a/doc/sphinx-guides/source/api/native-api.rst +++ b/doc/sphinx-guides/source/api/native-api.rst @@ -2513,7 +2513,7 @@ The fully expanded example above (without environment variables) looks like this curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -X POST "https://demo.dataverse.org/api/files/:persistentId/prov-freeform?persistentId=doi:10.5072/FK2/AAA000" -H "Content-type:application/json" --upload-file provenance.json -See a sample JSON file :download:`file-provenance.json <../_static/api/file-provenance.json>` from http://openprovenance.org (c.f. Huynh, Trung Dong and Moreau, Luc (2014) ProvStore: a public provenance repository. At 5th International Provenance and Annotation Workshop (IPAW'14), Cologne, Germany, 09-13 Jun 2014. pp. 275-277). +See a sample JSON file :download:`file-provenance.json <../_static/api/file-provenance.json>` from https://openprovenance.org (c.f. Huynh, Trung Dong and Moreau, Luc (2014) ProvStore: a public provenance repository. At 5th International Provenance and Annotation Workshop (IPAW'14), Cologne, Germany, 09-13 Jun 2014. pp. 275-277). Delete Provenance JSON for an uploaded file ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ From 1d5ec876de31a7bcb06b7a8bf78895a00e469852 Mon Sep 17 00:00:00 2001 From: kuhlaid <41551429+kuhlaid@users.noreply.github.com> Date: Sun, 31 Jul 2022 20:35:38 -0400 Subject: [PATCH 05/10] Update index.rst Removing index links because they no longer link to anything --- doc/sphinx-guides/source/index.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/sphinx-guides/source/index.rst b/doc/sphinx-guides/source/index.rst index f7e81756e5b..148518d2ce5 100755 --- a/doc/sphinx-guides/source/index.rst +++ b/doc/sphinx-guides/source/index.rst @@ -73,6 +73,4 @@ If you have a **security issue** to report, please email `security@dataverse.org Indices and Tables ------------------ -* :ref:`genindex` -* :ref:`modindex` * :ref:`search` From 6b9d175cd46be347c157f249e01b243f96d9824c Mon Sep 17 00:00:00 2001 From: kuhlaid <41551429+kuhlaid@users.noreply.github.com> Date: Sun, 31 Jul 2022 20:43:44 -0400 Subject: [PATCH 06/10] Update metadatacustomization.rst Fixing link to https://orcid.org --- doc/sphinx-guides/source/admin/metadatacustomization.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/admin/metadatacustomization.rst b/doc/sphinx-guides/source/admin/metadatacustomization.rst index 094f310a156..2ee68ccbaa5 100644 --- a/doc/sphinx-guides/source/admin/metadatacustomization.rst +++ b/doc/sphinx-guides/source/admin/metadatacustomization.rst @@ -565,7 +565,7 @@ In general, the external vocabulary support mechanism may be a better choice for The specifics of the user interface for entering/selecting a vocabulary term and how that term is then displayed are managed by third-party Javascripts. The initial Javascripts that have been created provide auto-completion, displaying a list of choices that match what the user has typed so far, but other interfaces, such as displaying a tree of options for a hierarchical vocabulary, are possible. Similarly, existing scripts do relatively simple things for displaying a term - showing the term's name in the appropriate language and providing a link to an external URL with more information, but more sophisticated displays are possible. -Scripts supporting use of vocabularies from services supporting the SKOMOS protocol (see https://skosmos.org) and retrieving ORCIDs (from https:/orcid.org) are available https://github.com/gdcc/dataverse-external-vocab-support. (Custom scripts can also be used and community members are encouraged to share new scripts through the dataverse-external-vocab-support repository.) +Scripts supporting use of vocabularies from services supporting the SKOMOS protocol (see https://skosmos.org) and retrieving ORCIDs (from https://orcid.org) are available https://github.com/gdcc/dataverse-external-vocab-support. (Custom scripts can also be used and community members are encouraged to share new scripts through the dataverse-external-vocab-support repository.) Configuration involves specifying which fields are to be mapped, whether free-text entries are allowed, which vocabulary(ies) should be used, what languages those vocabulary(ies) are available in, and several service protocol and service instance specific parameters. These are all defined in the :ref:`:CVocConf <:CVocConf>` setting as a JSON array. Details about the required elements as well as example JSON arrays are available at https://github.com/gdcc/dataverse-external-vocab-support, along with an example metadata block that can be used for testing. From 01e1d5291b01de7bb79b329ce3ba2b9a3049ce59 Mon Sep 17 00:00:00 2001 From: kuhlaid <41551429+kuhlaid@users.noreply.github.com> Date: Sun, 31 Jul 2022 20:55:50 -0400 Subject: [PATCH 07/10] Update prerequisites.rst Fixing URL to the R Project --- doc/sphinx-guides/source/installation/prerequisites.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/sphinx-guides/source/installation/prerequisites.rst b/doc/sphinx-guides/source/installation/prerequisites.rst index 0ad3bf600c9..b7a01ea2ce8 100644 --- a/doc/sphinx-guides/source/installation/prerequisites.rst +++ b/doc/sphinx-guides/source/installation/prerequisites.rst @@ -288,11 +288,11 @@ If the installed location of the convert executable is different from ``/usr/bin (see the :doc:`config` section for more information on the JVM options) -R +The R Project for Statistical Computing - -The Dataverse Software uses `R `_ to handle -tabular data files. The instructions below describe a **minimal** R +The Dataverse Software uses `R Project `_ to handle +tabular data files. The instructions below describe a **minimal** R Project installation. It will allow you to ingest R (.RData) files as tabular data and to export tabular data as .RData files. R can be considered an optional component, meaning that if you don't have R installed, you will still be able to run and @@ -300,7 +300,7 @@ use the Dataverse Software - but the functionality specific to tabular data mentioned above will not be available to your users. -Installing R +Installing R Project ============ For RHEL/derivative, the EPEL distribution is strongly recommended: From 1968c752e1c554060e99b19274a4aff8fc0982a3 Mon Sep 17 00:00:00 2001 From: kuhlaid <41551429+kuhlaid@users.noreply.github.com> Date: Sun, 31 Jul 2022 21:02:51 -0400 Subject: [PATCH 08/10] Update config.rst Fixing link to PIP --- doc/sphinx-guides/source/installation/config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst index 00d7654f06f..dd80464fd62 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -474,7 +474,7 @@ named config in the same folder") Console Commands to Set Up Access Configuration ############################################### -Begin by installing the CLI tool `pip `_ to install the +Begin by installing the CLI tool `pip (package installer for Python) `_ to install the `AWS command line interface `_ if you don't have it. First, we'll get our access keys set up. If you already have your access keys configured, skip this step. From ab8d609efec85aef5ef0751441a8462db5706926 Mon Sep 17 00:00:00 2001 From: kuhlaid <41551429+kuhlaid@users.noreply.github.com> Date: Sun, 31 Jul 2022 21:13:43 -0400 Subject: [PATCH 09/10] Update integrations.rst Fixing Renku documentation link --- doc/sphinx-guides/source/admin/integrations.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/admin/integrations.rst b/doc/sphinx-guides/source/admin/integrations.rst index f6ca34bf3d4..b29e51b581d 100644 --- a/doc/sphinx-guides/source/admin/integrations.rst +++ b/doc/sphinx-guides/source/admin/integrations.rst @@ -57,7 +57,7 @@ their research results and retain links to imported and exported data. Users can organize their data in "Datasets", which can be exported to a Dataverse installation via the command-line interface (CLI). -Renku dataset documentation: https://renku-python.readthedocs.io/en/latest/reference/commands.html#module-renku.cli.dataset +Renku documentation: https://renku-python.readthedocs.io Flagship deployment of the Renku platform: https://renkulab.io From b3d16837c436094f171af36ae5b78a6298b6af35 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Mon, 31 Oct 2022 15:57:58 -0400 Subject: [PATCH 10/10] revert to calling it just "R" not "R Project" #8873 --- doc/sphinx-guides/source/installation/prerequisites.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/sphinx-guides/source/installation/prerequisites.rst b/doc/sphinx-guides/source/installation/prerequisites.rst index 9f0a2b3063e..59de507a264 100644 --- a/doc/sphinx-guides/source/installation/prerequisites.rst +++ b/doc/sphinx-guides/source/installation/prerequisites.rst @@ -288,10 +288,10 @@ If the installed location of the convert executable is different from ``/usr/bin (see the :doc:`config` section for more information on the JVM options) -The R Project for Statistical Computing +R - -The Dataverse Software uses `R Project `_ to handle +The Dataverse Software uses `R `_ to handle tabular data files. The instructions below describe a **minimal** R Project installation. It will allow you to ingest R (.RData) files as tabular data and to export tabular data as .RData files. R can be considered an optional component, meaning @@ -300,7 +300,7 @@ use the Dataverse Software - but the functionality specific to tabular data mentioned above will not be available to your users. -Installing R Project +Installing R ============ For RHEL/derivative, the EPEL distribution is strongly recommended: