To simplify the build tool chain,
factor out Install Guide for Debian with debconf.
Continueously, keep Install Guide for Debian without debconf
in the doc/install-guide directory. Also, use the contents
at doc/install-guide as possible for consistency.
On the following patches, clean up doc/install-guide sources
to cleanup the contents and build tool chains.
Change-Id: I8df6b3b382137d08d60f85bc41bcd98ac1f4eb47
We do not need the DocBook XML glossary anymore, since we do not build
any DocBook guides that use it.
Add instead the RST version of the document to git.
Adjust scripts to not build or publish the glossary anymore.
Change-Id: Id4bfef7666690e6d08291f664751db7a4d4d5983
Previously "/generated/" is the folder in cli-reference. At present
as cli-reference is migrated to rst and no more using folder "/generated"
So we can remove this from .gitignore
Change-Id: I9b5bad398a4842abac4e94a6c8a87df3b4df0637
As discussed via email, let's do this on a smaller scale.
This reverts commit 9432a6da0cc341a879bc6f4ac48380248355e77a.
Change-Id: I27e9cd06c5d69917abe452e873873683e10c282a
Remove DocBook XML files and rename directory from install-guide-rst to
install-guide.
Adjust everything so that publishing works.
Update README to remove DocBook XML Install Guide specific instructions.
Implements: blueprint installguide-liberty
Change-Id: If723c44c3c0383dc8ab8e53798d82e7f0ee2cc57
Add support for conditionals for the Install Guide.
This uses the tags:
* rdo
* obs
* ubuntu
Note that this is changed from the spec since sphinx does not accept a
"-". Also, I changed from opensuse to suse for brevity.
Adds new tox target so that "tox -e install-guides" builds only the
RST Install Guide.
implements bp installguide-liberty
Change-Id: Ibdfbc7ff294e56f52cd6f4ef59ceeb7b6af3e28a
Build translated RST manuals. This needs openstack-doc-tools 0.26
release, thus bumped up requirements.
Import also Japanese User Guides translations so that this can be
tested. We only create an empty file for it, this will trigger the
import and enable us testing of the toolchain.
Ignore some build results.
Change-Id: Ic51974445730cbfa886beb7cfd4fcf71977dab3c
Automatically convert the glossary from DocBook XML to RST with each
build and use it for building the RST guides.
Add the glossary to User Guides and Networking Guide.
Use glossary in User Guides in places where it was used before. This
removes one TODO.
Fix CORS capitalization.
Partial-Bug: #1421813
Change-Id: I3fba6d54b01759f39f8e1467a7606cdbd2dd0165
- Uses -t admin_only tag for building the admin version of the user guide.
- Add files to cli.rst that were not included anywhere.
- Add flag -E to sphinx-build to ignore old content which might lead to
strange local build bugs.
- Add build-admin directory to .gitignore.
- Fix scope.py extension to properly remove files from toctree.
Co-Authored-By: Andreas Jaeger <aj@suse.de>
Change-Id: Ide51cf83c148060d3064ebcb9535b3d3a29c83cf
Fix generatepot-rst.sh script to not generate duplicate messages and
properly delete generated files.
Let git ignore any python compiled files.
Change-Id: Ib0cb58980ba2bc751cfed9ad56942aedfb62d07e
The 2 RST files are copied from the heat developer documentation without
any change and are just a starting point.
This patch requires this change in the openstack-doc-tools:
https://review.openstack.org/#/c/108034/
Change-Id: I03511655c86ead880cadfa68b43bb2b90d3f7c06
Implements: blueprint heat-templates
There's no shared usage for these files, so move them into a
subdirectory of cli-reference.
Call the subdirectory generated and add a README so that it's clear that
these are generated files.
Fix also .gitignore to only ignore some top-level directories.
Change-Id: Ifb455a8640cc7e735ed81563b438d68522e73ded
This patch does the initial conversion of the High Availability
Guide to XML from ASCIIdoc. No changes to the structure have
been made; this is simply the XML that gets generated by asciidoc.
This patch includes the following changes to the original HA
Guide:
- Content now appears in a single Docbook XML file, to be
broken out in the next patch
- Original ASCIIDoc files have been removed
- pom.xml has been updated to reflect the new source
- .gitignore has been updated so that it no longer ignores
bk-ha-guide.xml
This patch is simply to establish the new structure. To prevent
front-end disruptions it includes all of the existing content,
but the content hasn't been audited or broken out into individual
files. For ease of review, that will be done in the next
patch(es).
(This patch also includes the corrections and changes that were
originally part of https://review.openstack.org/#/c/93856/2,
corrected so that list appears properly.)
Implements: blueprint convert-ha-guide-to-docbook
Change-Id: I0455716c037b5e6e698bfca72162aba29f339e8a
Adds new FWaaS section to networking intro section. Adds overview
diagram. Includes operational FWaaS content moved from Advanced API
section.
Change-Id: I5b0a9182c25d624598d37172918ad8cd01d5f880
Closes-Bug: 1304745
This reverts commit 81a8a03. While .tx can certainly be generated by
infra jobs on the fly, this helps people that want to work on
translations with (local) tools instead of Transifex web-interface.
Change-Id: I77ed05e929cc7500ab4ab9a46e96eb6e1384e7a7
Folder .tx is used to save the configuration of Transifex Client.
Tracking .tx by git will cause an error while running the script:
propose_translation_update_manuals.sh
Folder .tx could be created on the fly.
So this patch removed folder .tx from git tree.
Change-Id: I582a11efc330abd3d263e1563d1ebed3fd42f974
Create new job for building of translated manual.
The job needs version 0.5 of openstack-doc-tools to support the "-l"
flag.
Change-Id: Ic898d364650a6f3e2aac2fa13af779627bd53883
Ignore publish-docs directory. This is the directory used by
openstack-doc-test to copy draft documents to.
blueprint draft-docs-on-docs-draft
Change-Id: I4267e02e540b4283b273092d8566894a2c422444
Remove unneeded gitignore files
Cleanup normal gitignore file a bit:
* Add Build results comment
* add slash to .tox to mark it as directory
Change-Id: I9a82a6353e3b8cec186e8b688489916d9355f0da
Added a few entries to ignore vagrant related files. These files
can tend to be heavy and are not required to be the part of the
source.
Removed Vagrant from the .gitignore. Thanks Trevor
bp/training-manuals
Change-Id: Icb89d49566367adcd4db5fe412914d852c22830b
Build books the same way we build them for publishing:
Build all three variants of the Install Guides if we check building.
Since we introduce os specific sections, the guide might build for one
variant but not the others.
In case of failure, the variant is shown like:
Building all queued 1 books now...
>>> Build of book install-guide (for Ubuntu) failed (returncode = 1).
Also, generate the xml file for the HA guide and build it.
Add generated file bk-ha-guide.xml to .gitignore
Add parameter -B for building to mvn to silence download progress
Run test.py and validate.py through pep8 and fix any issues
Change-Id: Icfb4587e7c08050d1b65dddc5a3a810a8bf12f5a
bug 1034021 trailing off sentence in overview
bug 1034772 included typo
bug 1034462 scheduler typo
bug 1017691 change in name of root wrap config option
Change-Id: Ia7ecf12f39771c49915b927ea3f0de89c9f28327
Added info in the README.rst about how to generate the documentation.
Word-wrapped all text to 78 chars or less.
Now ignores Oxygen XML editor project files (.xpr)
Change-Id: I167605c95c706ac1ef82393aa8301594ced1e01d