doc updates to better explain harvest server query format for subcollections #8197
Conversation
djbrooke
changed the title
Tried to clarify that the path should include all parent collections up to but excluding the Root collection. Also added @pdurbin's suggestion of using an API endpoint to get the Dataverse collection's database ID. It might be helpful to link to the section of the API Guide that documents that endpoint, which I think is https://guides.dataverse.org/en/5.7/api/native-api.html?highlight=unlock#view-a-dataverse-collection, but I don't know the best way to do this in this rst file. Tried looking through this rst file to for an example but I'm still not sure. @pdurbin could you add a link behind ""View a Dataverse Collection" API endpoint"?
Small grammar edit.
|
I'm done with my smallish edits. I asked in a commit comment if @pdurbin could help add a link behind the API endpoint referenced in the revised text. |
|
Sure, I added the link to the API Guide in 7b71433 Here's how it looks:
|
Capitalizing another "ID"
|
Thanks! So it's :ref:`view-dataverse` I'll try to remember that! Is everyone here okay with the change? I am |
|
@jggautier @pdurbin thanks - looks good to me. |
Yeah, you have to add the ref on the other side if it doesn't exist already. refs are a nice way to link to a specific part on the page, especially necessary on long pages. |
|
@jggautier - this is in review and assigned to you, so if it's in a state where you feel OK with it, feel free to approve (after clicking "files changed" above) and unassign yourself. This'll move it over to QA. Thanks to you and @pdurbin for the edits! |
From our edits to the section about the subtreePaths query, I copied the extra tip about using an API endpoint to get the database ID to the parentId query. That's the only other place, at least on this page, where the user needs to know what the database ID is and is given tips for how to get it.
What this PR does / why we need it:
Updating some docs to clarify how to create harvesting sets for subcollections
Which issue(s) this PR closes:
Closes IQSS/dataverse.harvard.edu#124
Special notes for your reviewer:
@jggautier edits very welcome!
Suggestions on how to test this:
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Is there a release notes update needed for this change?:
Additional documentation: