search

tumblr / collins

groovy kind of love
tumblr.github.com/collins
Apache License 2.0
572 stars 99 forks source link

Documentation cleanup #532

Closed byxorna closed 7 years ago

byxorna commented 7 years ago

@roymarantz @defect @michaeljs1990 Big documentation cleanup. Removes a bunch of outdated stuff, tumblr-isms, and assumptions. Clarifies what is native to Collins and what is to be implemented by your own automation.

Hoping to make the docs more readable and useful to people new to the collins ecosystem.

michaeljs1990 commented 7 years ago

Niceeee, only thing I feel like we might want to provide more guidance around is collins-cli vs collins_shell. i.e. I pretty much always use collins-cli except when I am trying to find some obscure fact from a machine or want to see a full print out of an assets available keys/values.

byxorna commented 7 years ago

@michaeljs1990 totally. Ive updated docs to discuss a bit more about that division, and included a section on creating and maintaining your collins configs with collins dc.

byxorna commented 7 years ago

@roymarantz updated!

byxorna commented 7 years ago

@roymarantz im going to land this today, so it can unblock the rest of the doc changes coming down the pipe! cc @defect