|
|
| (345 intermediate revisions by 45 users not shown) |
| Line 1: |
Line 1: |
| − | __NOTOC__
| + | Read the new content in the [http://docs.openstack.org/contributor-guide/index.html Documentation Contributor Guide]. |
| − | = How To Work on [[OpenStack]] Documentation =
| + | {{OpenStack_Documentation_Navbar}} |
| | | | |
| − | At the core of OpenStack is the community and collaboration that we do - the same rules for the code apply to documentation too. Ideally any code contribution that is merged into the base has documentation to go with it. Anne Gentle is the coordinator for all documentation efforts, both community-based and "official" docs. This page describes the methods we use to create the basis for world-class documentation for OpenStack developers and users.
| |
| | | | |
| − | == Tools Overview ==
| + | ---- |
| − | | + | [[Category:Documentation]] |
| − | Currently, we use this wiki, RST files stored in source code, ([http://docutils.sourceforge.net/docs/user/rst/quickref.html ReStructured Text], it has a similar text-based markup as wikitext) and [[DocBook]] to create OpenStack's web documentation.
| |
| − | | |
| − | The wiki is easy-peasy, you just request an account on wiki.openstack.org by emailing anne at openstack dot org, create a new page, and start editing.
| |
| − | | |
| − | Editing RST or DocBook has a few more steps and depends you getting the code for the project. To work on the DocBook source files, a working project exists in Github in the http://github.com/openstack/openstack-manuals project since DocBook documentation encompasses all three OpenStack projects. All API documentation has been moved to Github, and is housed in image-api, identity-api, compute-api, and object-api projects there. For Github hosted docs, you get a Launchpad account plus a Github account and use git for checking in and out docs.
| |
| − | | |
| − | If you're on a Mac, here are the quick steps for getting started on the openstack-manuals project:
| |
| − | | |
| − | 1. First install the Apache Maven project (with Macports, you can do this:).
| |
| − | | |
| − | <pre><nowiki>
| |
| − | sudo port install maven2
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | 2. Install Git by referring to http://help.github.com/mac-set-up-git/.
| |
| − | | |
| − | 3. Build the docs.
| |
| − | | |
| − | <pre><nowiki>
| |
| − | | |
| − | git clone https://github.com/openstack/compute-api.git
| |
| − | cd compute-api/openstack-compute-api-1.1
| |
| − | mvn clean generate-sources
| |
| − | | |
| − | </nowiki></pre>
| |
| − |
| |
| − | | |
| − | The RST source is built into html using Sphinx so that it gets displayed on [http://nova.openstack.org nova.openstack.org], [http://swift.openstack.org swift.openstack.org], and [http://glance.openstack.org glance.openstack.org].
| |
| − | | |
| − | The [[DocBook]] source is built into html (webhelp) and PDF using XSLT transforms included with the DocBook project.
| |
| − | | |
| − | A super light-weight drafting option, easy as a click-through, is to write with other collaborators on an Etherpad at http://etherpad.openstack.org/. We can invite others as we go, and choose to write it as wikitext, RST, or docbook.
| |
| − | | |
| − | {| border="1" cellpadding="2" cellspacing="0"
| |
| − | |<tablestyle="font-size: 0.95em; border: 2px; width: 100%; background-color: #cccccc;">| wiki
| |
| − | | RST
| |
| − | |-
| |
| − | | Use for project docs, blueprint specs.
| |
| − | | Use for Python developer documentation and quick starts.
| |
| − | |-
| |
| − | | The audience is any project team member of OpenStack.
| |
| − | | The audience is Python developers who want to work on the project.
| |
| − | |-
| |
| − | | Output is per-page at wiki.openstack.org
| |
| − | | Output goes to nova.openstack.org, glance.openstack.org, swift.openstack.org, and so on.
| |
| − | |}
| |
| − | | |
| − | wiki.openstack.org (wikitext or RST)
| |
| − | -------------------------------------
| |
| − | | |
| − | The OpenStack wiki contains draft documentation but should ideally contain project docs, specs, doc drafts, and outlines. Any dev or user doc on the wiki is subject to constant change so if there's a page you want to keep an eye on (like Nova installations for example), add it to your Notifications list (under User > Settings > Notifications in the wiki). I've also begun a copy/paste effort to put RST in wiki pages to avoid multiple maintenance on pages that are also housed on nova.openstack.org, for example. There are great pages on the wiki that I want to take to the other doc sites, for example the Nova deploy page on the wiki should be highlighted in other locations as well.
| |
| − | | |
| − | nova.openstack.org, swift.openstack.org, glance.openstack.org (RST)
| |
| − | -------------------------------------------------------------------
| |
| − | The RST pages stored with the project code should be written with a developer audience in mind, although many times you'll find there is overlap in what an admin needs to know and what a developer needs to know. High priorities for those sites are wider coverage of doc strings, API doc, i18N methodology, and architecture concepts that'll help developers.
| |
| − | | |
| − | docs.openstack.org ([[DocBook]])
| |
| − | ----------------------------
| |
| − | As mentioned above, the source for this site is housed in Github in the http://github.com/openstack/openstack-manuals project, the Launchpad page for this project is https://launchpad.net/openstack-manuals. You can either build the output locally if you want or just submit changes to the source XML through merge proposals. The OpenStack Jenkins build server builds the doc and copies the output to docs.openstack.org/trunk automatically thanks to the pom.xml files included in the source files.
| |
| − | | |
| − | * doc/source/docbkx/$BOOK contains the [[DocBook]] XML source files and images
| |
| − | | |
| − | To generate the PDF and webhelp within your local environment, install Maven. Then, to generate documentation for one of the manuals, go to the root directory of that manual (e.g., doc/src/docbkx/openstack-compute-admin) and do:
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | mvn generate-sources
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | The html file starts at doc/src/docbkx/openstack-compute-admin/target/docbkx/webhelp/trunk/openstack-compute/admin/index.html and the PDF will be doc/src/docbkx/openstack-compute-admin/target/docbkx/webhelp/trunk/openstack-compute/admin/os-compute-adminguide-trunk.pdf.
| |
| − | | |
| − | You may need a modified settings.xml and if you already have M2_HOME set, you might see an error about "java.lang.[[ClassNotFoundException]]: org.codehaus.plexus.classworlds.launcher.Launcher" - just run unset M2_HOME.
| |
| − | | |
| − | Versions of Doc
| |
| − | ---------------
| |
| − | For RST-based documentation, you can get to a point-release of a docs site by going to http://swift.openstack.org/1.1, for example. We'll keep doing that for ongoing releases. For Swift, we now have archived sites for the 1.4.0 and 1.4.1 release at swift.openstack.org/1.4.0 and swift.openstack.org/1.4.1. To make those archived sites, you can run a build on the Jenkins server at http://jenkins.openstack.org/view/Swift/job/swift-docs-archive/ and enter the version number and the Launchpad branch that you want to use to build the archived site. For [[DocBook]] documentation, the Continuous Integration work keeps docs building to docs.openstack.org/trunk.
| |
| − | | |
| − | == Audiences and Targets ==
| |
| − | | |
| − | OpenStack has three main projects - Compute (nova), Object Storage (swift), and now an imaging service (glance). While the goals you'd achieve using each project vary, the three projects can also be used together. Those three projects have two basic audiences - developers and sysadmins (think operations or dev-ops). The RST-based documentation, because it automatically generates doc from docstrings in the code, is much more for a developer audience. There are two types of developers that the developer documentation serves - Python developers who want to work on OpenStack code, and web developers who work with the OpenStack API.
| |
| − | | |
| − | == Workflow ==
| |
| − | | |
| − | The workflow for documentation matches the workflow for code - you download a branch, work on it locally, then commit the changes and propose a merge. Your changes are merged into the main, published doc base, and the doc is built to its varying outputs.
| |
| − | | |
| − | === Detailed Workflow with Github and Gerrit ===
| |
| − | | |
| − | The page I always refer to for using Git and Gerrit for daily tasks is
| |
| − | http://wiki.openstack.org/GerritWorkflow.
| |
| − | | |
| − | The workflow takes some startup work to get the accounts you need. First, you make a Launchpad account, and upload a public key. Then, you identify your Launchpad account to the git command line and away you go. You also need a Github account. The Launchpad account contains the signon and permissions information for the Gerrit workflow that we use for reviews.
| |
| − | | |
| − | Here's a sample for the documentation project specifically, once you get your Launchpad and Github accounts set up.
| |
| − | | |
| − | Create the directory where you want to store the doc source files, then switch to it.
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | mkdir ~/src/docs
| |
| − | | |
| − | cd ~/src/docs
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | Follow the steps in [[GerritWorkflow]], using openstack-manuals as the project name for the Admin manuals, and project-api, such as compute-api, for the project name for API guides.
| |
| − | | |
| − | Now you can check out all the files for the admin doc project:
| |
| − | | |
| − | <pre><nowiki>
| |
| − | git clone git://github.com/openstack/openstack-manuals.git
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | Set up the Gerrit Change-Id hook, which is used for reviews, and run git review to run a script in the /tools directory which sets up the remote repository correctly:
| |
| − | | |
| − | <pre><nowiki>
| |
| − | cd $PROJECT
| |
| − | git review
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | Now make sure you have the latest from Github (docs move more slowly than code, but this is a good practice).
| |
| − | | |
| − | <pre><nowiki>
| |
| − | git checkout master
| |
| − | git pull origin master
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | Lastly, create a branch to do your work in that you'll do commits from:
| |
| − | | |
| − | <pre><nowiki>
| |
| − | git checkout -b TOPIC-BRANCH
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | Edit happily! You can use [http://www.oxygenxml.com/ Oxygen] since you're working on an open source project and we acknowledge their support.
| |
| − | | |
| − | When you're done with edits, if you've added any files do this in the working directory:
| |
| − | | |
| − | <pre><nowiki>
| |
| − | git add .
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | Next, you commit your changes with a message that'll be displayed in review.openstack.org, creating a change set:
| |
| − | | |
| − | <pre><nowiki>
| |
| − | git commit -a -m 'Here's what I did in this set of changes'
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | Next, push your changes for review with:
| |
| − | | |
| − | <pre><nowiki>
| |
| − | git review
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | Go to the review site itself to request a merge with the openstack-manuals project, at review.openstack.org. One of the core doc team members will review your edits and let you know if any changes are needed prior to merging them in.
| |
| − | | |
| − | == Acknowledgment ==
| |
| − | | |
| − | Thanks to the generosity of Oxygen in supporting open source projects, you can edit DocBook XML within the Oxygen Author or Editor by downloading a copy of the software from http://www.oxygenxml.com/. Send an email to support @ oxygenxml dot com requesting the license extension beyond the 30-day trial.
| |
| − | | |
| − | == Translation ==
| |
| − | | |
| − | Translation efforts should occur either in the Launchpad Translations area (for strings in the code, error messages and the like) or on the wiki, which has translations enabled.
| |
| − | | |
| − | == Figures ==
| |
| − | | |
| − | Here are some conventions for including figures and images in [[DocBook]] and RST documents.
| |
| − | | |
| − | In DocBook source, here is how you include images that have both a scalable-for-print-resolution in the PDF and an online-resolution for the HTML output. In this case the two types of images are SVG and PNG formats. The scale="60" attribute ensures that the image does not overlap print margins nor take up too much screen space.
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | <figure xml:id="CFinterfaces">
| |
| − | <title>Cloud Files System Interfaces</title>
| |
| − | <mediaobject>
| |
| − | <imageobject role="fo">
| |
| − | <imagedata scale="60" fileref="figures/CFinterfaces.svg"/>
| |
| − | </imageobject>
| |
| − | <imageobject role="html">
| |
| − | <imagedata scale="60" fileref="figures/CFinterfaces.png"/>
| |
| − | </imageobject>
| |
| − | </mediaobject>
| |
| − | </figure>
| |
| − | | |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | For [[DocBook]], the convention is to use the /src/figures/ directory to store both the source image and any other formats of that same image. The pom.xml file copies the files in the /figures/ directory into the output directory required for HTML in the post processing section.
| |
| − | | |
| − | Also, when you add the image to the /src/figures directory, be sure to tell the source control system that you've added the image. For example, use "bzr add" to ensure the images get added to source control so the HTML and PDF output will be built correctly by the Jenkins continuous integration server.
| |
| − | | |
| − | For RST documents, this is the syntax for including an image in the output:
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | .. image:: /images/dating_service.png
| |
| − | | |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | The /images directory is relative to the doc/source directory, within /source. There's also an images_src directory in the doc/source directory that contains the source images so that they can be updated when needed.
| |
| − | | |
| − | For any figure you create, please also include the source files, even if the image was not created with open source tools, for maintenance purposes. While all OpenStack docs are created with open source in mind, including open-licensed fonts in the output, we are willing to allow non-open authoring or image creation tools if it's more efficient.
| |
