search

fgrehm / vagrant-cachier

Caffeine reducer
http://fgrehm.viewdocs.io/vagrant-cachier
MIT License
1.08k stars 111 forks source link

Yes we have Docs!!!! #64

Closed fgrehm closed 10 years ago

fgrehm commented 10 years ago

Guys, I took some time to improve our docs and came up with this http://fgrehm.viewdocs.io/vagrant-cachier~docs

I did my best to make things easier to understand and I'd love some feedback about it :smiley:

On a side note, I've also documented some "gotchas" along the way like the issue with bundle install --deployment and the fact that the rvm bucket need some tweaking to provisioning scripts to work and also wrote down some notes I had about how people can help us out to implement support for new buckets.

Closes GH-56

/cc @mindreframer @cromulus @fh @gimler @laggyluke @patcon @tmatilai

fgrehm commented 10 years ago

Oh well, looks like viewdocs is currently having issues with relative linking, so you guys will need to manually type in the links for now =/

But don't worry, it will be working fine once it gets merged back into master if the issue has not been fixed by then :)

tmatilai commented 10 years ago

Looking great! I expect you do the same to vagrant-proxyconf. :D

fgrehm commented 10 years ago

Ok folks, relative linking is working fine now and it will make your lives easier when reviewing and I'll wait for at least one more :thumbsup: before merging it back to master :)

fh commented 10 years ago

@fgrehm I currently get just a "file not found", apparently viewdocs still has some issues..

fgrehm commented 10 years ago

@fh would you mind trying out again? http://fgrehm.viewdocs.io/vagrant-cachier~docs is working fine for me oO

gmiroshnykov commented 10 years ago

Wow, this looks great!

The only issue I've found is with benchmarks table - it's not very readable with this formatting: screen shot 2013-12-09 at 2 03 56 pm

fh commented 10 years ago

@fgrehm This is weird. It works on Chrome and Safari, but not on Firefox - apparently some encoding problem with the ~ in the url.

fgrehm commented 10 years ago

@tmatilai sorry I missed out your comment, thanks for having a look at it and expect some proper contributions to vagrant-proxyconf next year :)

@laggyluke thanks! I just did some tweaks on that table and this is how it should look like as soon as viewdocs cache gets evicted:

screenshot from 2013-12-09 10 34 55

@fh thats really weird.... but I think it's not a big problem, the ~ will go away once we merge the branch back into master :)

fgrehm commented 10 years ago

Alright guys! I'm bringing this one in after lunch. If someone is against it please :point_up:

fgrehm commented 10 years ago

It's LIVE! http://fgrehm.viewdocs.io/vagrant-cachier

patcon commented 10 years ago

:dog2: so merge much live

fgrehm commented 10 years ago

@patcon wat?!?!

patcon commented 10 years ago

http://knowyourmeme.com/memes/doge :)