search

cedardevs / onestop

OneStop is a data discovery system being built by CIRES researchers on a grant from the NOAA National Centers for Environmental Information. We welcome contributions from the community!
GNU General Public License v2.0
45 stars 20 forks source link

Document workflow for external developer #1096

Open ajakz opened 4 years ago

ajakz commented 4 years ago

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

erinreeves commented 3 years ago

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

erinreeves commented 3 years ago

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

erinreeves commented 3 years ago

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.