Commit Graph

21 Commits

Author SHA1 Message Date
Andreas Jaeger d12fd3653f Remove tools/glossary-sort.sh
The glossary is imported automatically from openstack-manuals, no need
to test that it is sorted as this is done in openstack-manuals already.

Change-Id: If57bda8c5f83d7c833387f0c6ee7ea570d785dac
2018-11-24 18:57:03 +01:00
Sean McGinnis c68bdb82bf Restore operations-guide content
This restores the content of the repo to include all changes that
were done while the content was moved to the openstack-manuals
repo. There were also some updates and fixes to get the content
to build and pass jobs with the current doc job definitions.

Change-Id: Ic05b44a210a93667490096cffc8f2e45575ffb34
2018-06-28 10:52:46 -05:00
Andreas Jaeger c8ca0febaa Retire repository
Retire repository following the process on retiring an OpenStack
repository:
http://docs.openstack.org/infra/manual/drivers.html#remove-project-content

This removes *all* content and just leaves a single README.rst that
explains how to get it.

Change-Id: I36ca5788dbc3e44b5421b88e64972585f8820947
Depends-On: I9f4e21b44c717d11511fea48db54a52103e294b1
2016-05-05 20:40:53 +02:00
KATO Tomoyuki ebef3ac27b [ops-guide] Fix wrong path to common files
Change-Id: I1bd01cd17d40094da50d58068085e38f5436e734
Implements: blueprint ops-guide-rst
2016-03-10 15:43:32 +09:00
KATO Tomoyuki 7b824ddc5c [ops-guide] Set up initial RST structure
Change-Id: Ife2178f4f17d08f5797310990bb22662819ed106
Implements: blueprint ops-guide-rst
2016-03-10 03:28:44 +00:00
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
Andreas Jaeger 0415bf95ca Remove tools/generatedocbook
This is not used anymore, we use the script from openstack-doc-tools
now.

Change-Id: I3094e4bc64b8ccfc234cc0aff22b1533e38e772f
2014-10-09 15:10:11 +02:00
Christian Berendt dfa5acbaeb Remove @author tags from copyright statements
We have git to track the authorship of files. It is not necessary to use
the @author tags in the copyright statements.

Change-Id: I66572547c5532965cd3ae356bc9e297e71e13f2c
2014-10-09 09:28:06 +02:00
Andreas Jaeger 178153c557 Use doc-tools-check-languages
Use new global language checking script and remove
test-languages.sh.

Change-Id: Ida42fb1b9e7d57f9697657cf90f1dc8874d9e28c
2014-08-18 20:57:23 +02:00
Andreas Jaeger 40f4d63051 Move glossary to its own directory
This allows sharing of glossary and its translation between the various
documentation repositories.

Also import locale files and just test-languages.sh.

implements bp common-glossary-setup

Change-Id: I01d68f29d5a4e713e17ed88815644ad40f98bf71
2014-08-01 21:24:03 +02:00
Andreas Jaeger 3140092730 Cleanup for translation
Remove non-existant option from test-languages.
Use test as parameter for buildlang target.

Change-Id: I4afd3b90f76c8fdff3d1be7917c11ef30e621a69
2014-07-07 18:56:24 +02:00
Andreas Jaeger b4a93f2de6 Rework translation tests
Rework test-languages so that we can test *all* languages as well
if needed and use the same script for both buildlang and testlang.
Add new tox job "publishlang" to publish all languages at once.

Change-Id: Ia8abe50ae798887ed62eaa8c81a4c7472021f718
2014-06-30 21:44:42 +02:00
Andreas Jaeger 6bb3b8f57a Create checklang tox.ini target
Create target to test that localized manuals are actually building.

Change-Id: Ia9ad298c4e9ee24f774e986d46c3c370d6046376
2014-05-15 16:43:56 -04:00
Akihiro Motoki e43b39ad65 Fix path used in generatepot
The generatepot script used to generate POT files for translation
still used an old pre-restructure path.
This patch fixes to use the new path "doc".

Change-Id: I424f8b8f6c38a0b08f80fc0e72d3cd52785abba5
Closes-Bug: #1275596
2014-02-03 11:47:13 +09:00
Andreas Jaeger 9bff2eee16 Remove tools/validate.py
The tool is not used anymore since we use tox based gating.

Change-Id: I147cb04495fef8b2f1a5b2318b1a11b4a402dd42
2014-01-28 19:58:27 +01:00
Tom Fifield 6b5c3a8ab0 Update generatedocbook in tools dir
This is a small change primarily to test the
openstack-operations-guide-ja build job. It mirrors
a similar change to openstack-doc-tools, which should
deprecate this tools directory.

Change-Id: I14c385e71d3ac4fa9f922d84048ee20f6198c6a0
2014-01-16 11:11:57 +08:00
KATO Tomoyuki b47d0fb633 Add Docbook XML mode in tools/generatedocbook
tools/generatepot uses Docbook XML mode.
It replaces elements of several types with placeholder.

  eg: <command>ps aux</command>  ->  <placeholder-1>
      [aaa.xml]
        run <command>ps aux</command>.
      [aaa.pot]
        msgid "run <placeholder-1>."
        msgstr ""

Then, translatores translate strings with placeholder.

  eg: [ja.po]
        msgid "run <placeholder-1>."
        msgstr "<placeholder-1> wo jikkou."

So, tools/generatedocbook need to merge the tranlation strings,
considering Docbook format.

If not be considered, the strings containing a placeholder
element remains untranslated because msgid does not match.

  eg: [aaa.xml]
        run <command>ps aux</command>.
      [ja.po]
        msgid "run <placeholder-1>."    <- not match
        msgstr "<placeholder-1> wo jikkou."

Change-Id: Ieb32ed8bfb0b6880040e47e3700b812f81598d8a
2013-07-09 13:45:06 +09:00
daisy-ycguo df20e745e6 Update generatedocbook
Add namespace "xlink" to attribute "title" under element "link"

Bug #1178395

Change-Id: I41dfa51a03dc59efcd96004190aa42d5278dccdf
2013-05-10 03:49:48 +08:00
daisy-ycguo 0d1e97550b Add slicing tool to the master branch
This patch added tools used for slicing and merging in translation process.
The patch also includes the POT files for each documents.
The PO files are not included, which can be downloaded from Transifex.

Fixes: bug #1153415
Change-Id: Ia455134c99acb1129e8f10deda0d85867b1ef9a3
2013-03-12 15:23:36 +08:00
Lorin Hochstein 6d76f4c234 Fix XML schema validation failures
With this patch, running the tools/validate.py script will return
no DocBook RelaxNG schema validation failures.

Once this patch lands, and the equivalent lands in stable/folsom,
I will follow up on getting this run automatically by Jenkins so
we can see the results when there are new doc patch proposals.

There were three XML validation failures that were addressed

openstack-compute-admin/rootwrap.xml:

rootwrap.xml had to xml:id values that were the same. These have
been changed so they are different. It turns out this file was not
being included in the documentation at all. I submitted a separate
patch to include it: https://review.openstack.org/20551

openstack-compute-admin/computeconfigure.xml:

computeconfigure.xml had xi:include elements with an 'os' attribute.
This violates the spec, and it doesn't work, either. We had two
lines that looked like this:

<xi:include os="ubuntu" ...>
<xi:include os="rhel;fedora;centos" ...>

and both files were being included in the docs. This was changed so
that only one file is included, and there's a note that has been
added that describes the difference between the two files, which
is very minor (just one parameter).

openstack-ha/ha-guide-docinfo.xml:

This isn't a real XML file, it's a fragment of XML that is used
by a non-standard toolchain. The validation script has been configured
to just ignore it for now.

Change-Id: Ie77218efc56c16b7bf162f5e02fd7a6d99116dc1
2013-01-26 21:17:05 -05:00
Lorin Hochstein 215cc04add Add script to validate files are valid DocBook.
Adds a script called tools/validate.py that will check all XML
files against the DocBook 5 RELAX NG schema.

Does not check pom.xml files or files inside of directories named
"target".

Change-Id: I9614f1b10ac2da608a245c7644309a5be38c8995
2012-12-15 21:28:05 -05:00