Go to file

Tom Fifield adc764dd81 Ignore <option> tags in generatepot

After https://review.openstack.org/#/c/144685 merges,
the automatically generated configuration reference
tables will be marked up as
<option>option_name</option> = <replaceable>default_value</replaceable>

As none of this should be translated (option_name is the same
regardless of language), this patch updates generatepot to ignore
option_name s tagged with <option> for translation.

This should significantly reduce the number of strings required for
translation from the common directory in particular, where
many of the 8000-odd strings do not actually need translation.

Change-Id: I093056c182bf0bb3ca79892b66f1e9239a323da1

2015-01-01 20:30:00 +08:00

doc

Imported Translations from Transifex

2014-12-27 06:00:39 +00:00

tools

Ignore <option> tags in generatepot

2015-01-01 20:30:00 +08:00

.gitignore

Remove folder .tx from git tree

2014-03-13 11:07:08 +08:00

.gitreview

Changes license to CC-by 3.0.

2013-06-12 13:27:23 -05:00

doc-test.conf

Remove extra line from doc-test.conf

2014-02-12 21:39:49 +01:00

doc-tools-check-languages.conf

Add doc-tools-check-languages.conf

2014-08-16 06:59:03 +02:00

LICENSE

Changes license to CC-by 3.0.

2013-06-12 13:27:23 -05:00

README.rst

Fix URL in README.rst

2014-02-14 15:41:04 +01:00

test-requirements.txt

Updated from global requirements

2014-10-13 23:10:29 +00:00

tox.ini

Make sure that tox uses python2 by default

2014-10-31 08:41:40 +01:00

README.rst

OpenStack Operations Guide

This repository contains the source files for the OpenStack Operations Guide.

You can read this guide at docs.openstack.org/ops.

It was originally authored during a book sprint in February 2013. Read more about Book Sprints at http://www.booksprints.net.

Additionally, a tools directory contains tools for testing this guide.

Prerequisites

Apache Maven must be installed to build the documentation.

To install Maven 3 for Ubuntu 12.04 and later,and Debian wheezy and later:

apt-get install maven

On Fedora 15 and later:

yum install maven3

Contributing

This book is undergoing a custom edit with O'Reilly publishing and we welcome contributions to make it as accurate as possible. Our target is the Havana release.

The style guide to follow is at chimera.labs.oreilly.com.

Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation. The best way to get involved with the community is to talk with others online or at a meetup and offer contributions through our processes, the OpenStack wiki, blogs, or on IRC at #openstack on irc.freenode.net.

Testing of changes and building of the manual

Install the python tox package and run "tox" from the top-level directory to use the same tests that are done as part of our Jenkins gating jobs.

If you like to run individual tests, run:

tox -e checkniceness - to run the niceness tests

tox -e checksyntax - to run syntax checks

tox -e checkdeletions - to check that no deleted files are referenced

tox -e checkbuild - to actually build the manual

tox -e buildlang -- $LANG - to build the manual for language $LANG

tox will use the openstack-doc-tools package for execution of these tests.

Installing OpenStack

Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.