search

kirillian / shiplane

Convert your development docker-compose yaml files into production-ready docker deployments
MIT License
34 stars 0 forks source link

Add RDocs #9

Open kirillian opened 5 years ago

andrewmcodes commented 5 years ago

Want to add a description for this? I can help out here.

Is this just for adding rdocs or for also documenting methods?

kirillian commented 5 years ago

Hmm...I would love help. If I'm honest, I may end up having to do a lot of the heavy lifting as the gem is likely to have major changes (the Kubernetes module I've been working on has definitely introduced some structural changes). That being said, this is definitely something I'd love to have some help on.

The primary pieces I'm thinking about this for are the core methods in the gem as well as documentation on the tasks themselves. The idea here being that I would like to provide some insight as to what is going on inside so that others can join in (hence my belief that I might have to make the first pass at this).

If you are still interested, I would be happy to pair with you and talk you through this a bit better, let you ask whatever questions you want and maybe talk you through the pieces themselves and how they fit together.