Commit Graph

23 Commits

Author SHA1 Message Date
Andreas Jaeger 60ab492106 Small cleanups
the repo is building using Python 3, so remove some cruft:
* Remove python 2 requirements
* Remove python2 stanza from setup.py
* Remove obsolete sections from setup.cfg
* Remove unused variables from tox.ini

Change-Id: Ia56048d901f2fa0099341f349b02c7ac76a40b82
2020-04-07 13:09:25 +02:00
Adam Spiers 393604c6b7 import draft from openstack-manuals/doc/ha-guide-draft/
Move the draft of the restructured HA guide to this dedicated
repository, in order to focus reviews on a smaller, more specialist
audience and accelerate development.

Change-Id: I95a4b46fecaafafd1beb8314d1cf795b60fb17a8
2018-11-23 00:55:15 +00:00
Sean McGinnis 34c59c7cb5
Create skeleton for restoring ha-guide content
This just sets up all the framework pieces to allow content to be added
back into the ha-guide.

Change-Id: I3b5a77407f9d91fe85d7749a6ec70870f75dc482
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2018-09-20 08:34:30 -05:00
Andreas Jaeger 1510c36ac5 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 the content

Depends-On: I9f4e21b44c717d11511fea48db54a52103e294b1
Change-Id: I4281697640489a779a3ef82b23174262a0baa3fc
2016-05-06 08:49:12 +02:00
Andreas Jaeger 1a881fa9ed Use openstack-indexpage
Use openstack-indexpage to generate index page, there's no need
to run openstack-doc-tools since this repo only uses RST documents.

Change-Id: Ic005bd63efe47f012360e5a5634e545c5cb81920
2016-04-29 20:12:41 -05:00
Andreas Jaeger 3390645b94 Remove xml2po cruft
We do not use DocBook XML in this repository and thus do not use xml2po
anymore. Remove comments and settings that are not needed anymore.

Change-Id: I2648743b671d9bdc553caf51756f7bb1fae396c0
2016-03-28 15:45:50 +02:00
KATO Tomoyuki 58284843f9 Rename common-rst to common
Change-Id: I601a27bb398ca21504530ca4298d304ab1688d46
2016-02-14 18:29:25 +09:00
Ian Y. Choi 1c48e65df0 Fixed tox exec warnings with obsolete deletion
Current tox execution generated total three warnings.
Two warnings are from checkdeletions and checklinks,
both of which are obsolete now.
The other warning is from checklang because bash command
is in /bin, not in testenv:checklang environment.

So this patch removes some tox obsolete sections:
checkdeletions, checklinks and checksyntax as well,
and adds bash to whitelist_externals in checklang.

Change-Id: If514445272ef9fb5e0f182ba8407e195adaa0b62
Closes-Bug: #1518413
2015-11-21 19:52:31 +09:00
Andreas Jaeger 2bff7a1d4b Use doc-tools-build-rst
Update to openstack-doc-tools 0.31 and use doc-tools-build-rst file from
that repo.

Change-Id: Ibf1f4dc4b3af36fdbd3b90defd3499f08258f632
2015-10-12 20:20:31 +02:00
Andreas Jaeger ad5004e927 Delete XML HA Guide
Only publish the RST HA Guide.
Publish it under docs.openstack.org/ha-guide, so not as draft anymore.

Change-Id: I4afef0100d21aaa7215ac7f1ee49fdd4c3e7a4e3
2015-10-12 12:21:13 +02:00
Andreas Jaeger 9f68014abe Start translation
Create an empty RST file, our scripts will add content to it.
Enable translation via the config file.
Add the usual tools/generate-pot-rst.sh to build pot files.
Add the usual target to tox.ini for RST translation.
We need openstack-doc-tools 0.30 or newer for RST translations.

Change-Id: I9100d663460cd7baa0c09954d17e728c1534a0ee
2015-08-27 11:51:08 +02:00
Andreas Jaeger 4374d7392b Prepare for translation of common files
Move imported files to common-rst directory so that we can share
translations with openstack-manuals.

Change-Id: I726dbee599936db532215d29e944da06ecf890c7
2015-07-23 19:05:17 +02:00
Jenkins 2383bd5c45 Merge "Convert Cinder HA doc to RST" 2015-07-14 12:16:32 +00:00
Andreas Jaeger dfee1fc5df Rework RST building
Use the same shell scripts like openstack-manuals for building of
RST files. This simplifies the tox.ini file.

Change-Id: I2e04245e8b507c447139ed132b09b019b79af985
2015-07-12 11:59:51 +02:00
Meg McRoberts a9418d6245 Convert Cinder HA doc to RST
This converts the existing documentation about implementing
high availability for Cinder to RST.  It includes some minor
editorial changes but no content enhancements.

This content needs to be updated and expanded after the conversion
is completed.

Also, disable D000 doc8 check since it does not handle the lineos
directive. This is the same fix that was done for openstack-manuals.

Change-Id: I87e18696d5e18833361cfad0c50d20bff616d74f
2015-07-12 08:24:42 +02:00
Jenkins d0bc508676 Merge "Enable doc8 and fix failures" 2015-06-08 20:22:51 +00:00
Andreas Jaeger e0857dfc9b Publish draft RST ha-guide
Publish RST ha-guide as draft for easier review.

Change-Id: I229d5f777913b6f6b4188219351df80200557092
2015-06-02 19:18:35 +02:00
Andreas Jaeger 6683789a49 Enable doc8 and fix failures
Enable doc8 for checknicess jobs.

Fix failures noticed by doc8, especially overlong lines.

Fix wrong doc8 parameter for ignoring files.

Change-Id: I770d4cf38a21b79cfad00318d6336dd4d459500a
2015-05-28 13:22:59 +02:00
Andreas Jaeger 15a9918a40 Use /draft for RST ha-guide
For checkbuild, use /draft for the ha-guide to make it clear that this
is a draft and to better differentiate between the two guides.

Change-Id: I33a6976d46dbc5e60c54f1a1c163c9ea8fd257bf
2015-05-06 19:25:54 +02:00
Andreas Jaeger da1bfe426d Add RST infrastructure for HA Guide
This adds the basic infrastructure for building and checking the HA
guide using RST.

The guide is not published to draft yet, this should be done once
there's real content.

Partially implements bp improve-ha-guide
Co-Authored-By: Nick Chase <nchase@mirantis.com>

Change-Id: I7c40ccb80d77e7a6fd763b778945ee0869b7e1c0
2015-05-02 09:08:43 +02:00
Gauvain Pocentek b1d36c177b Make sure that tox uses python2 by default
Our documentation tools are not python3 compatible, so make sure that
tox creates python2 virtual environments during tests.

Change-Id: Id92edea211778a02676ebcbd7598d36a5aef239f
2014-10-31 08:39:40 +01:00
Andreas Jaeger 1e6ccf3ede Fix build problems
Fix paths so that the book builds.

Change-Id: I16484b1e3f4304ff8a22cc4f55f2638d10382e69
2014-09-19 20:33:35 +02:00
Andreas Jaeger c6bf631ce7 Setup ha-guide infrastructure
Add files for building and testing.
2014-09-15 19:40:07 +02:00