The JSON formatting created by jsoncheck.py omits the file's final
newline. It claims that files with such a newline need reformatting
and removes the final newline in a file when reformatting.
This patch brings jsoncheck.py in line with the rest of the tools
which prefer text files to end with a newline.
Update release notes for pushing out the bug fix.
Closes-Bug: #1403159
Change-Id: I35eab544b183c05b167ce9917d92f0f1f919b745
The internal references were not properly created. This patches make the
:ref: inline markup create a <xref> tag when the reference is internal.
This patch also reworks the sphinx extension to handle the URLs that
will be generated in the hot-reference with the new :ref: behavior.
Closes-Bug: #1378073
Change-Id: I84bf268dc1055dc6b39f23c4415734184ec57eec
The glance v2 commands need to be called as:
glance -os-image-api-version 2 CMD
Implement logic for this and enhance output.
Closes-Bug: #1367430
Change-Id: Ibc81d49494a203c9c8f469a2a0f93e4c1786af7e
This extension simplifies the generation of hyperlinks referencing HOT
resources in the hot-reference book. It will be used in the hot-guide.
Change-Id: I382b5960733bec9b96924475887b02c8b1b01ea6
Implements: blueprint heat-templates
wrapper:
- Don't modify the openstack-manuals repo if it exists, keep it as is
git wise (no branch change, no pull)
- Install oslo.i18n and hplefthandclient
- First setup the environment, then do the update/docbook work
autohelp.py:
- Handle projects not using oslo.i18n (mostly for havana)
diff_branches.py:
- Update the output format
- Setup the venv for the requested projects only
Change-Id: I48c45a56f4b7b7298fef0b7595d62e445c92df39
Ignore patches that only update the po files unless translations should
be built.
Update release information for 0.19.
Change-Id: I587688d207d244e72e1fc035d4fe5d72a1b5da88
This patch provides all necessary files and configurations to
build a Vagrantbox that can be used as building and testing
environment for all OpenStack manuals and documentations. It
includes the repositories like openstack-manuals. Tox, Maven
and all needed dependencies by Maven are already
installed/fetched.
Change-Id: Ic7a496ee16efffc7ae41f657a07af998436ea12e
Closes-Bug: #1317849
Add new option --check-links that checks that links are valid
and reachable.
Change-Id: I1a709bcbf47c7fdfbdc5e4da55457d7ccb70604c
Co-Authored-By: Christian Berendt <berendt@b1-systems.de>
This is an initial import of an improved version of tools/test-languages.sh
used in repositories like openstack-manuals or security-doc.
Following improvements are included:
* add missing license header
* fix E003: Indent not multiple of 4
* fix E020: Function declaration not in format "^function name {$"
* rename variables inside methods
* rewrite usage information
* refactor/rename methods (test_fr, test_ja, test_language, setup_lang)
Change-Id: I9fead76f6552fd3f7317605f1e6a0f9cf5b69b26
The current version only uses directory as source for tranformation.
This patch allows to work on a single source file. This is intended to
be used to generated the HOT reference data.
Change-Id: I574c099c26718e0ca509a492e857c96e7bdc0e15
Test if a *modified* file belongs to the HOT guide, instead of doing
this in the XML validation loop.
Change-Id: Iea0d955be63c8f0bf11619b4d2203e7646cbcb65
Closes-Bug: #1351844
This tool converts docutils native XML to docbook. The conversion is
done using XSLT, with some custom XML treatment.
The XSL source is a slightly modified version of Dn2dbk written by Éric
Bellot (http://ebellot.chez.com/dn2dbk/index.htm).
Modify doctest to check and build the HOT guide.
Implements: blueprint heat-templates
Change-Id: If866a5ffe19165c38981493684de550e0df0e36d
diff_branches.py generates a listing of the configuration options
changes that occured between 2 openstack releases.
This involves a few changes in other tools:
- the 'dump' subcommand for autohelp.py generates the serialized dict of
options
- add a special case for the 'bindir' option to avoid getting different
default values in different virtual environments
- the autohelp-wrapper -e switch builds the needed venv without
running autohelp.py commands
Change-Id: I80da172b91b8d2f0a15f89f4c812864da2fea471
https://review.openstack.org/#/c/94717/ triggered a bug in handling of
ignore_dirs: If a file in one of the ignored directories was changed, we
might still create dependencies for it and trigger an exception. Now we
remove also modified files in ignored directories.
Change-Id: I619d6c441a4fa4759e00d9c9e21c993707b19c6b
xml2po breaks the entities, readd the %openstack if needed.
Note: If more entities are imported in translated files, we need to
rework this completely.
Change-Id: Ia1a955f2cfc5810db21d68d5f9cc4374a42cebd2
Closes-Bug: #1322224
The High Availability Guide is currently written in ASCIIdoc, so
the tox scripts have to convert it to Docbook before continuing to
test. Remove all special casing needed for this.
Co-Authored-By: Andreas Jaeger <aj@suse.com>
Change-Id: I5a6c13e502d003237eb93d27028de2cb9db02e04
Implements: blueprint convert-ha-guide-to-docbook
Build all manuals, if an entity file is changed, we cannot do include
checks right now if an entity file is changed.
Update list of special files to handle, remove obsolete test.py and add
top-level pom.xml
Change-Id: I2c139249bb97fbd43781fafefd9f72e3f663935e
Patch https://review.openstack.org/#/c/94194/ changes the location
of the v3 API, handle the new directory.
Change-Id: Iadadec17d525acede71853c00ec4f075c75c0a05
The generatedocbook tool only works on XML files.
For the high-availability guide, we first need to generate the XML file
and then integrate translations - and take care that the build job not
regenerates the XML file.
Change-Id: Iab7a72d2819b4fc5d0bac53b8a9ccba2ba9ef0ef
- generate the tables in the doc/common/tables dir by default
- make the -i switch optional, and assume that git git repositories are
in a ./sources/ dir
- use elif's instead of multiple return statements in the subcommand
test
Change-Id: If96ac9df247cea5061c056328307ec88ab74a4f3
Add a new script that can reformat JSON files and check for niceness.
We can use this later as niceness check for openstack-doc-test.
Change-Id: I33c5309bfa2e1abfa6a35d1cfcdc984775e85f05
Non-breaking space is often not visible in our tools, or shown as normal
space. We should use instead. Warn about non-breaking space like
we warn about tabs.
Change-Id: I1bbbb1f19c56d3cc1b949df151b41886a0c46042
Related-Bug: #1314498
Change way on how the screens are generated so that we really
have </screen> on the closing line.
Also, update swift usage line so that it is not inside a screen but in a
normal para.
Add new option --output-directory for defining the directory where the
files will be written to.
Change-Id: Ie5d039ad673290720993586bd137c51183afa822
The code for parsing existing tables didn't find all the options because
of spaces and new lines. This patch should now handle those characters.
Change-Id: If6a5d8812e6e6f46e14944578cc5eb94d8374ccf
Christian Berendt
Roger Luethi
Andreas Jaeger
Gauvain Pocentek
Pranav Salunke
Nicholas Chase