Skip to content

8023 doc adminguide add#8024

Merged
kcondon merged 9 commits intoIQSS:developfrom
philippconzett:8023-doc-adminguide-add
Nov 19, 2021
Merged

8023 doc adminguide add#8024
kcondon merged 9 commits intoIQSS:developfrom
philippconzett:8023-doc-adminguide-add

Conversation

@philippconzett
Copy link
Contributor

What this PR does / why we need it:
This PR provides documentation on how admins can retrieve information about whether a certain Dataverse collection is linked to or links to any other collection. The documentation is proposed to be part of the Dataverse Admin Guide.

Which issue(s) this PR closes:
Closes #8023.

Special notes for your reviewer:
I'm not quite sure about the use of quotation marks in the curl command. Should it be "X-Dataverse-key: $API_TOKEN" or X-Dataverse-key: $API_TOKEN? It tested only the version without quotation marks.

Suggestions on how to test this:
Run the command in your terminal.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:
No.

Is there a release notes update needed for this change?:
No.

Additional documentation:
None.

Merge from original repo
Turned allowmultiples facetable for Citation Metadata field Production Place from FALSE into TRUE as we'd like to be able to add multiple production places and to be able to filter dataset based on this metadata field.
Turning Citation Metadata section Series from allowmultiples=FALSE to allowmultiples=TRUE.
@djbrooke djbrooke self-assigned this Jul 26, 2021

Provides information about whether a certain Dataverse collection ($dataverse-alias) is linked to or links to another collection. Only accessible to superusers. ::

curl -H X-Dataverse-key:$API_TOKEN http://$SERVER/api/dataverses/$dataverse-alias/links
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @philippconzett for the PR! The rest of the examples have quotation marks, so please add them here for consistency. I'm looking at some recent API calls that I've made to the Harvard Dataverse repository where I've used quotation marks and the commands have successfully run. Thanks again!

@djbrooke djbrooke assigned philippconzett and unassigned djbrooke Jul 26, 2021
Added quotation marks.
@djbrooke djbrooke self-assigned this Jul 26, 2021
Backed out the changes as suggested by Danny.
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change to the docs looks good (thanks!) but the change to citation.tsv should not be included. If it's easier to make a new pull request, that's fine.

@djbrooke
Copy link
Contributor

Hi @philippconzett - as @pdurbin mentions, it looks like there's still a change in the citation.tsv file.

@djbrooke djbrooke removed their assignment Aug 12, 2021
@djbrooke djbrooke assigned djbrooke and unassigned philippconzett Nov 19, 2021
Copy link
Contributor

@djbrooke djbrooke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the .tsv changes have been moved out, so I'm approving this based on #8024 (review)

@djbrooke djbrooke removed their assignment Nov 19, 2021
@kcondon kcondon self-assigned this Nov 19, 2021
@kcondon kcondon merged commit 8ec9c26 into IQSS:develop Nov 19, 2021
@djbrooke djbrooke added this to the 5.9 milestone Nov 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Add section to Admin Guide on how to retrieve information about linked Dataverse collections

4 participants