UCSC-Treehouse / pipelines

Makefiles to run dockerized pipelines used in Treehouse on a single sample
Apache License 2.0
3 stars 6 forks source link

Updates to documentation for initial setup #13

Closed ghost closed 5 years ago

ghost commented 6 years ago

Adds documentation to bypass setup errors.

e-t-k commented 6 years ago

Thank you @aglyle ; I'm satisfied.

@klearned , passing this to you -- could you please do a readthrough of the new treeshop.md for potential improvements?

klearned commented 6 years ago

Yes, I'll read through the new treeshop.md today

ghost commented 6 years ago

Thanks for the comments @klearned! @e-t-k can you take a final look at these changes and I'll ping Rob to merge the branch.

e-t-k commented 6 years ago

@aglyle looks great. I approve this doc.

ghost commented 6 years ago

@rcurrie Updates to the treeshop.md ready to be merged with master. Let me know if there's anything you want me to change.

rcurrie commented 6 years ago

Good work - thank you for filling in pieces. I made a bunch of comments (feel free to push back!). In general I want to be careful about helping someone use this vs. helping someone that shouldn’t be using this.

On May 31, 2018, at 12:35 PM, Geoff Lyle notifications@github.com wrote:

@rcurrie https://github.com/rcurrie Updates to the treeshop.md ready to be merged with master. Let me know if there's anything you want me to change.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/UCSC-Treehouse/pipelines/pull/13#issuecomment-393652268, or mute the thread https://github.com/notifications/unsubscribe-auth/AAeEGjVKXYBzwy1aThYuhOxVnJIVkIVYks5t4EXngaJpZM4TW7PA.

ghost commented 6 years ago

@rcurrie Incorporated your comments. Removed sections that we expect users to know (SSH Key creation), unsure if you wanted to keep PATH setup or not, but it's removed in the latest version. Also moved documentation for shutting down select machines and different fabfiles to links in the options. Removed shutting down IPs as it is Treehouse specific.