Open sourcing - Githubissues

chrisdone commented 9 years ago

Some items for clean up before open sourcing:

[x] Fix the docs for commandline options (e.g.'stuff' and 'junk' with something proper) and any other "TODO"-ish code.
[x] Add FP Complete copyright field to .cabal file.
[x] Check that cabal haddock yields something reasonably nice as an FP Complete product.
[x] Write up a README explaining what the tool is for, the basic architecture and the few included commands.
[x] I think our dependency on base is too restrictive. Can it be lifted to <5?
[x] A final review by other FP Complete devs to try it out.

That should be it and then we can open source the project and upload to Hackage and include in Stackage.

DanBurton commented 9 years ago

I see no harm in boosting the base upper bound. bb5b2bf

DanBurton commented 9 years ago

I wrote up a README. I think it's rather longwinded and should probably be pared down, or part of it moved to a blog post or something. ee045f63

chrisdone commented 9 years ago

Nice work! This does a good job of explaining the commands and architecture.

Yeah, I think the Examples section probably belongs on a separate page about sandbox use; maybe a wiki page or a blog post. Pinging @snoyberg for third opinion.

snoyberg commented 9 years ago

No strong opinion; I don't have an objection to a long README. Blog posts bitrot, so I don't think that should be the canonical source of information.

On Tue, Apr 7, 2015 at 12:57 PM Chris Done notifications@github.com wrote:

Nice work! This does a good job of explaining the commands.

Yeah, I think the Examples section probably belongs on a separate page about sandbox use; maybe a wiki page or a blog post. Pinging @snoyberg https://github.com/snoyberg for third opinion.

— Reply to this email directly or view it on GitHub https://github.com/fpco/stackage-cli/issues/8#issuecomment-90493060.

chrisdone commented 9 years ago

If not a blog post then I think it should be changed to read more like formal docs than a blog post.

DanBurton commented 9 years ago

I propose: everything before Example stays in the readme. Everything after Example goes into a blog post. The readme has a link to the blog post for those who want to see the example. The readme's link to the blog post can be deleted or updated as things change.

chrisdone commented 9 years ago

Sounds good.

DanBurton commented 9 years ago

We'd like to have #14 done before release.

DanBurton commented 9 years ago

I've done as proposed and moved the example to the wiki.

chrisdone commented 9 years ago

Alright, I'll do a once over check here for all the features and then pass to Michael to review.

chrisdone commented 9 years ago

@snoyberg So I gave this a final sanity check and I'm happy with it. The global configuration I've only reviewed and tested, but the sandboxes I'm using on my own personal projects now. Want to give it a try yourself?

chrisdone commented 9 years ago

(Also, I've tested it with the nascent stackage-build and it works unmodified as expected.)

snoyberg commented 9 years ago

OK, steps to do to finish this:

[x] Have others review blog post
[x] Make this repo public
[x] Release to Hackage
[x] Add to Stackage
[x] Post blog post
[x] Release a new version of the stackage package, which depends on stackage-cli and stackage-update, for users who type in cabal install stackage
[ ] Possibly: update instructions on stackage.org/install and yesodweb.com/page/quickstart

snoyberg commented 9 years ago

Let's hold off on updating instructions on stackage.org/install and yesodweb.com/page/quickstart until we get more user feedback on the tool.

fpco / stackage-cli

Open sourcing #8