onestop icon indicating copy to clipboard operation
onestop copied to clipboard

Document workflow for external developer

Open ajakz opened this issue 5 years ago • 3 comments

Summary

We have two developer types that would need access to our docs -- this user story covers the external developer that is building a tool that has to interface with OneStop somewhere.

A lot of the documentation that these types of users would need will probably already exist throughout the Public User and Metadata Manager paths, but there are some definite gaps in those two user types that we'll need to populate info for here. We will want to point to existing docs where we can.

Tasks

  • [ ] Create outline for use case workflow through documentation
  • [ ] Create documents for developer types
    • [ ] Thin portal creator - search api

ajakz avatar Nov 26 '19 01:11 ajakz

Reference OneStop/api docs? Or is this only the python-client?

erinreeves avatar Mar 13 '21 15:03 erinreeves

Suspect this is more "update readmes/docs for python-client". So working on that.

erinreeves avatar Mar 20 '21 02:03 erinreeves

Followed steps in the python-client/scripts readme. Need more info on what the next steps would be. Such as which scripts a SME user should/would use. Perhaps 1 line summary of each script in there.

erinreeves avatar Mar 22 '21 16:03 erinreeves