search

openaustralia / yinyo

A wonderfully simple API driven service to reliably execute many long running scrapers in a super scaleable way
https://yinyo.io
Apache License 2.0
6 stars 1 forks source link

Minimum set of documentation for go-live #109

Closed jamezpolley closed 4 years ago

jamezpolley commented 4 years ago

We should have a minimum set of documentation ready for the first public release. What should that set of information include?

I'm starting a draft list here; I expect this list will change as we discuss it. I'm starting by thinking about the different types of people who might want to look at these docs

Status Persona Question Answer
❎ Deployer How can I create a test deployment of Yinyo? Deployment procedure
✅ Developer I want to contribute to Yinyo. How do I create a dev environment? As per current README.md
🟩 Developer What is the API? API docs

Required by #14

mlandauer commented 4 years ago

Based on the recent discussion, the focus on the initial release is just for developers. Next we'll have a production instance ready to go. So, it makes sense at that stage to focus on how to get going using the production instance. Setting up your own instance is down the list of priorities. I'm going to close this issue because I think it's mostly out of date now.