Project

General

Profile

Feature #6404

Add an API synopsis page that gives a quick overview of the DataONE API and other developer tools.

Added by Matt Jones over 7 years ago. Updated almost 6 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Target version:
Start date:
05/06/2014
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Bugzilla-Id:

Description

The DataONE API documentation is overly complex and can be intimidating. Provide a quick overview on the KNB for developers that can get people started with the REST API and the Java and Python clients. Have this description be the main linkout on all pages pointing at the API, and in turn link from this page to the DataONE API documentation for the details for reference.


Subtasks

Task #6547: Add sample query and instructions for getting the view count of an object in the API overview pageResolvedLauren Walker


Related issues

Related to MetacatUI - Feature #6810: Create detailed user documentation for MetacatUINew07/28/2015

History

#1 Updated by Matt Jones over 7 years ago

  • Assignee set to Lauren Walker
  • Status changed from New to In Progress
  • Description updated (diff)

I started to draft this page under the KNB templates under the file 'developers.html'. The page is straight html, and I inserted <html>, <head>, and <body> tags to get it to load standalone in a browser without the view machinery.

TODO:
1) Create a view and router for this new page
2) Edit for clarity
3) Make the formatting more consistent and make it fit the site
4) Add brief descriptions and links to the Java and Python client sections.

#2 Updated by Matt Jones over 7 years ago

I think a good example of a nav sidebar menu for traversing a long API document can be seen at https://parse.com/docs/rest -- I was thinking of something like that with the sidebar links which I hadn't finished formatting.

#3 Updated by ben leinfelder over 7 years ago

I think if we do incorporate this, the route/view/template should be in the default theme and useable by all other themes -- the API pertains to all Metacat deployments, not just the KNB.
It also seems like this would be more appropriately placed in the Metacat documentation where we already have a chapter dedicated to DataONE topics as they relate to Metacat.

#4 Updated by Lauren Walker over 7 years ago

I was thinking it might be more appropriate for the Metacat documentation as well. Is this meant to be a guide for anyone who want to interact with the KNB via their customized tool (in which case being on the KNB website makes sense) or instructions for member nodes to create their own Metacat UI?

#5 Updated by Lauren Walker over 7 years ago

  • Target version changed from 1.5.0 to 1.6.0

#6 Updated by Lauren Walker over 7 years ago

  • Status changed from In Progress to New

#7 Updated by Lauren Walker over 7 years ago

  • Target version changed from 1.6.0 to 1.7.0

#8 Updated by Lauren Walker over 6 years ago

  • Target version changed from 1.7.0 to 1.8.0

#9 Updated by Matt Jones about 6 years ago

Updated the API page, which is now accessible in MetacatUI at the /#api route. Needs editing before release.

#10 Updated by Lauren Walker almost 6 years ago

  • Status changed from New to Resolved

Formatted, edited, and styled the API docs some more - could still use some more development time if we want to make a fully comprehensive API doc, but I think this is good for a first pass to put live on KNB

Also available in: Atom PDF