framed-data / overseer

Overseer is a library for building and running data pipelines in Clojure.
Eclipse Public License 1.0
97 stars 10 forks source link

Update README.md, cut 1.0.0 #67

Closed andrewberls closed 8 years ago

elliot42 commented 8 years ago

I feel like we should upgrade intake-mixpanel and test it in production for a while before we cut 1.0?

elliot42 commented 8 years ago

I think the current docs are insufficient to describe how to walk someone through setting this thing up and running it

elliot42 commented 8 years ago

i.e. I don't think people will try a thing out until they can see the start to finish in a QUICKSTART, and then read the details later in specific wiki pages

andrewberls commented 8 years ago

I'm going to write a gitbook once the repo is open source, don't feel like paying for private repo for however long it takes. And most of the changes this encompasses are things like doc updates, function inlining (compiler/tested) ...

andrewberls commented 8 years ago

See https://onyx-platform.gitbooks.io/onyx/content/

elliot42 commented 8 years ago

I think most people definitely do not want to have to read a book in order to get Hello World set up with a system...

andrewberls commented 8 years ago

It's basically a wiki with better organization. We can include a hello world quickstart (the hello world of Overseer fits on a slide, which is nifty), but of course a valuable resource to have when attempting to accomplish anything meaningful

elliot42 commented 8 years ago

:ok: though I still think it's basically irresponsible practice to cut a major version release without having tested the previous versions/changes ourselves. The community-responsible way to do this moving forward will be to issue a release candidate, and when the release candidate has been verified to be working properly for a sufficient amount of time, then the only thing that changes is the version bump to stable major release.

elliot42 commented 8 years ago

Otherwise we are basically telling everyone "you should move to this stable new thing" without having even tried it out ourselves at all (since intake-mixpanel has run for zero seconds with the latest changes)

andrewberls commented 8 years ago

Well again the behavior of the code has not changed in any way, at all. I can go ahead and make it a minor version bump and run a graph just for completeness, for me the version was just a nice formality

elliot42 commented 8 years ago

Various of the previous changes should not have been point releases, they should have at least been minor (if the API was changing, behavior like pre-process etc.)

Let's run this thing at the same version without changing it for at least like...a few days at least before we call a thing stable 1.0.