Hello community, Until recently, CloudStack had one writer (me). Two months ago we added Radhika PC (cc'd). We've both been working to get the documentation into a state where the community can contribute.
Radhika and I have sent notes already describing the tools we are adopting to make collaboration possible. Aside from the nuts and bolts of the infrastructure, we also need to set up some processes. This brings up the following questions: 1. How should a doc contribution be submitted? Can we use the same patch submission process as for code, or do we need some modifications? 2. Who reviews a doc bug fix? Who reviews a large new document? Only a maintainer? Or does the community at large review all docs? Would it be useful to set up an alias like cloudstack-doc-reviewers? Any special tweaks when using the Review Board for doc patches? 3. What constitutes a doc review? We'd like to have hands-on testing of how-to docs. Can this be handled by volunteers from the community? Subject matter experts should check for technical accuracy. What else should the review consist of? Are we going to have coding conventions for things like indentation and white space in the XML tags? 4. Who can approve a patch or new document? Any committer, or just the doc maintainers? If we can discuss and agree on these topics (and others that will come up!), we can add a "contributing to documentation" section to our "how to contribute" web page. Thanks in advance for your ideas, Jessica T. CloudStack Tech Pubs
