On Tue, Apr 9, 2013, at 10:12 AM, Jason Cadmus wrote: > I am working on installing/testing/documenting CS 4.10 on vSphere 5.1 > using vDistributed Switching with CS advanced networking. Can someone please > give me some insight on the proper way to contribute to CS formal > documentation?
Thanks, and sure! I'm not sure what level of help you're asking for, so forgive me if some of this is information you're already in possession of: 1) Our docs are written in Publican (a subset of DocBook) and stored in Git with the rest of the code under docs/en-US/ 2) Clone the git repo and create a branch to start working on your docs. Ideally, this would be on a system where you can run Publican to verify the docs. 3) There's a README.txt under docs/ that provides a short intro to Publican, accepted tags, etc. 4) It sounds like you're going to be doing something that belongs in the admin guide, so start a new section or chapter with a filename like "working-with-vdistributed.xml" and add it to the "Admin_Guide.xml" includes in the order you want it to appear in the guide. 5) Once you're done, test building it with Publican. If that works, submit a patch (diff) via Review Board (https://reviews.apache.org/dashboard/) and mark it for the cloudstack-git repository. For reviewers, select "cloudstack" as the group, and the appropriate folks for reviewers. (You can add me - jzb - and I can check it for validity, but not so much for content since I don't work with vDistributed Switching). Note - please make sure you submit a patch that works against master and 4.1 if possible. If you have questions, feel free to ping us in IRC on #cloudstack-dev as well if you want real-time(ish) feedback. I'm usually around during the day, and chipc, ke4qqq and others can also assist. (Or keep asking on dev@ as well, that works too.) Look forward to the patches! Best, jzb -- Joe Brockmeier j...@zonker.net Twitter: @jzb http://www.dissociatedpress.net/
