-
Notifications
You must be signed in to change notification settings - Fork 490
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Beginner friendly API documentation #6086
Comments
I gave talk called "Introduction to Dataverse APIs" to the support team for Harvard Dataverse and others who were interested. Here was the handout I provided, which is simply the table of contents from the "Introduction" page from the API Guide that I re-wrote (in the pull request I intend to create) and a new image explaining what an API is. I didn't have any slides. (Sorry, @shlake, I did see your tweet at https://twitter.com/shlakeuva/status/1161315003342835712 😄 ) The talk emphasized the following points:
For anyone who attended (thanks!) please feel free to add comments here. I'll get to work on that pull request to get my proposed changes into the API Guide. 😄 |
I wanted to mention that I'm attempting to fix both problems. Note that in the example below, color highlighting has been added for variables and long lines wrap across multiple lines: |
I just created pull request #6107 and I'd love feedback. I'm happy to add on to it. |
add beginner friendly API documentation #6086
As I mentioned in the "Upcoming talk on the Dataverse API" thread on the mailing list, I'm adding some more introductory material to the guides to explain what Dataverse APIs are and how they can be used by support teams and others are not deeply technical and programmer-y: https://groups.google.com/d/msg/dataverse-community/V5WkMGDS4VI/maxXTdmzDwAJ
I don't plan to create a ton of diagrams but here's an example of what I've come up with so far:
I'm constantly deploying some proposed changes the the one above to this server if anyone would like a sneak peek: https://dev2.dataverse.org/guides/
I may or may not try to address other smallish issues flagged as "API Guide" while I'm in there: Feature: API Guide
Here's a screenshot of those many issues:
The text was updated successfully, but these errors were encountered: