Jump to: navigation, search

Difference between revisions of "Docs Bootcamp 2013"

(What's Expected)
Line 41: Line 41:
 
Bring a laptop to work on. Mac, Ubuntu, Fedora, and RHEL are known to work. I haven't installed git review on Windows so I don't know if a Windows laptop would work.
 
Bring a laptop to work on. Mac, Ubuntu, Fedora, and RHEL are known to work. I haven't installed git review on Windows so I don't know if a Windows laptop would work.
  
Have the First Time Contributor process finalized, including signing the CLA and getting git review working. The steps are:{{#lst:Documentation/HowTo|first-time-contrib}}
+
Have the First Time Contributor process finalized, including signing the CLA and getting git review working. The steps are: [[Documentation/HowTo#First-time_Contributors]]
  
 
You should have current tools installed for working with documentation. This includes Maven and an editor of choice for editing DocBook or WADL documents.  
 
You should have current tools installed for working with documentation. This includes Maven and an editor of choice for editing DocBook or WADL documents.  

Revision as of 16:59, 29 July 2013

What is it?

The OpenStack Docs Bootcamp offers a deep dive into the technical tools, workflows, and processes we use to create docs.openstack.org and api.openstack.org. Our goal is to give enough information that we'll create sustaining members who are core to OpenStack docs. The session isn't a book sprint and we don't expect huge output from the event itself, rather, we want to provide all the information we can so attendees can go back and become sustained contributors to the documentation efforts.

Schedule:

DocBook (day one)

Build/automation tooling (day one)

Operations/Admin/Install Docs (day two)

API and User Docs including WADL (day two)

You can register to attend through this form.

When is it?

Monday September 9 through Tuesday September 10, 2013

Where is it?

Mirantis is playing host in sunny Mountain View, California and will offer lunch and dinner, thank you Mirantis!

Hotels near the Mirantis office:

Ramada 55 Fairchild Drive Mountain View, CA 800-252-1709

Quality Inn and Suites 5 Fairchild Drive Mountain View, CA (650) 934-0155

What's Expected

What's Expected

Bring a laptop to work on. Mac, Ubuntu, Fedora, and RHEL are known to work. I haven't installed git review on Windows so I don't know if a Windows laptop would work.

Have the First Time Contributor process finalized, including signing the CLA and getting git review working. The steps are: Documentation/HowTo#First-time_Contributors

You should have current tools installed for working with documentation. This includes Maven and an editor of choice for editing DocBook or WADL documents. Any DocBook editor will do such as Oxygen or Emacs with validation or vi: https://fedoraproject.org/wiki/How_to_use_Emacs_for_XML_editing https://fedoraproject.org/wiki/Editing_DocBook_with_Vi If you don't have a floating license for Oxygen, use Emacs or vi.

Have git installed, know the basics of git and git review, and have clones of the modules you'll be working on. The main doc repos are: openstack/openstack-manuals openstack/api-site