correct storageDrivers docs, fix formatting #6954
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
djbrooke
added this to Code Review 🦁
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
automation
moved this from Code Review 🦁
to QA 🔎✅
Jun 2, 2020
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
automation
moved this from QA 🔎✅
to Done 🚀
Jun 2, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
@jmjamison reported having trouble with the storageDrivers API. @qqmyers explained the fix. See https://groups.google.com/d/msg/dataverse-community/w_5FEN2UKSE/zKz_3B8dAgAJ
While fixing the typo I noticed that smart quotes (and no grey background) were in the HTML of some of the commands like below so I fixed that too. Here's how the docs looks as of Dataverse 4.20:
Which issue(s) this PR closes:
Closes # (none)
Special notes for your reviewer:
I didn't take the time to convert these commands to the new style seen at http://guides.dataverse.org/en/4.20/api/getting-started.html#curl-examples-and-environment-variables . If we want this now I'm happy to do it. @pkiraly has been helping a lot with this (thanks!!).
Suggestions on how to test this:
Build the docs. It's probably a good idea to test the API endpoints but I only changed the last one about listing storage drivers.
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.