Add an API synopsis page that gives a quick overview of the DataONE API and other developer tools.
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.
#1 Updated by Matt Jones almost 8 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.
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.
#3 Updated by ben leinfelder almost 8 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 almost 8 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?