Open Writing! Collaborative Authoring for CloudStack Documentation by Jessica Tomechak

  • Published on
    30-Oct-2014

  • View
    1.406

  • Download
    0

Embed Size (px)

DESCRIPTION

Open Writing! Collaborative Authoring for CloudStack Documentation by Jessica Tomechak

Transcript

1. November 2012Open Writing !For Apache CloudStack(Incubating) 2. Well Cover:Where We Are Our doc website Our modular doc repo Community participationHow We Do That Wiki for doc process docs Docbook + Publican for authoring Reviewboard for reviews Jira for doc bugs Jenkins for continuous doc builds IRC and lists for discussions Transifex for localizationHow We Got Here Joining Apache From unstructured to modular source Why Publican? And other design decisionsHow You Can Do That Becoming a doc contributor 3. Where We Are:Basically Where We Are Doc website:incubator.apache.org/cloudstack/docs/Old doc website: docs.cloudstack.org (soon to redirect) Doc source:git-wip-us.apache.org/repos/asf/incubator-cloudstack.git Doc team:cwiki.apache.org/confluence/display/CLOUDSTACK/Documentation+Team Mailing list:cloudstack-dev@incubator.apache.org 4. Where We Are:Apache CloudStack Doc Website 5. Where We Are:Pre-Apache CloudStack Doc Website 6. Where We Are:Doc Source Code Repo 7. How We Got Here:CloudStack is Donated to Apache In April 2012, Citrix Systems Inc. donated CloudStack code anddocumentation to the Apache Software Foundation, and CloudStack enteredthe Apache incubation process, the first step towards becoming a full-fledgedApache project CloudStack already had lots of published technical documentation, mostly asdownloadable PDFs with source in Microsoft Word Citrix tech pubs team aimed to donate the documentation in a way that wouldenable open-source contribution and align with open-source practices 8. How We Got Here:From Unstructured to Modular Source Docbook XML: community preferred this 100%. Familiar to most members. Discussion brief! How to get from MS Word to Docbook XML? Given