115 Commits

Author SHA1 Message Date
Andreas Jaeger
21edbc931f Fix ZUUL_REFNAME
Set up the variables the same way the post job is set up:
Pass them in via environment in job definition.

Pass ZUUL_ environment variables through to jobs.

Note ZUUL_REFNAME is not set, use ZUUL_BRANCH instead.

Change-Id: I5863a05384c9a48445d5ce52ccc508519c7c00f8
2017-11-23 17:16:14 +01:00
Andreas Jaeger
9f40d75a78 Remove checkniceness
We do not need this tox environment anymore, remove it.

Also, update documentation for jobs with Zuul v3.

Change-Id: I226835ad57af775a77e4719c5dcf7d13010ebd76
2017-10-27 10:13:19 +00:00
Doug Hellmann
adefde9826 make checkniceness an alias for linters in tox
The parent patch added a linters environment as an alias for
checkniceness. This makes linters the "real" environment and
checkniceness the alias.

Change-Id: I9778abf3315e62f9db2a8d98dfb4bc5e9e2e869d
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-10-09 10:04:06 -04:00
Andreas Jaeger
8439442601 Prepare for Zuul v3
As part of migration to zuul v3, replace checkniceness by linters tox
target to use a more "common" target accross OpenStack.

Remove the msgfmt check, this is now done in the translation sync
scripts, so no need to run it again here.

Change-Id: Ie50dba2c1eb7cbb2ce4d3ddf5b35dddaf355cb7f
2017-10-07 19:25:23 +02:00
Doug Hellmann
dcd0ce9584 use whereto to test redirect rules
Add a file containing the tests for all of the redirect rules and set
up whereto to run during the check. The test file is a template, just
like the htaccess file, to ensure we auto-generate the rules for all
of the various project redirects.

Fix a few issues with the template generator that ended up producing
duplicate or useless rules.

Change-Id: I0d306149dc33f64d44d9482fab02101bd1f6d7f5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-08-25 18:56:14 -04:00
Andreas Jaeger
639f235b23 Cleanup tox.ini
Remove targets and files that are not used anymore.

Change-Id: I48c44a1cf86db86e11e574cfc68696a0c1070504
2017-07-21 20:25:56 +02:00
Andreas Jaeger
33e278602f Update RST building
No need for build-install-guides-rst.sh, move to build-all-rst.sh.
Simplify build-all-rst.sh since we now do not have versioned or draft
docs anymore.

Change-Id: I213eff811d83ddfb1da3bb15dd8c99adeec93eb9
2017-07-21 20:25:56 +02:00
Andreas Jaeger
aa0743a8e4 Remove obsolete comments and usage
We do not build and translate docbook XML anymore, so do not need
Generatedocbook anymore. Remove the now obsolete comment and also the
sitepackages usage that was only needed for these.

Change-Id: I383a09b557f67bf490f9bfa4b9e30ebe416d95ac
2017-04-02 18:22:41 +02:00
Anne Gentle
e83d3baffc Does not build PDF by default with tox -e docs
* Will build PDF by default when using publish though.

Change-Id: I3fc45c4ff657a394316a0bc5d71b2260507b80b3
2017-03-01 20:20:27 +09:00
Jenkins
ab4eeb9c52 Merge "tox: Disable doc8 checks for autogenerated tables" 2017-03-01 03:56:11 +00:00
Andreas Jaeger
b06db69322 Document bindep usage
We use bindep to install our requirements, explain how to use it.

Also, add the bindep tox environment.

See also
https://docs.openstack.org/infra/manual/drivers.html#package-requirements

Change-Id: Ief208e5649223d9d3577ee0a30afdc7db35a86a9
2017-02-24 18:38:46 +00:00
Stephen Finucane
90e9b4cf67 tox: Disable doc8 checks for autogenerated tables
There are some doc8 rules which would be valuable for these
autogenerated files (like whitespace checks), however, some others do
not make any sense (mainly line length). As it does not appear to be
possible to use wildcards for the 'ignore-path-errors' setting, so we
must disable all checks on the files themselves.

Change-Id: I0adc353d1f1c975ae788a8e38d9c9b12168b23e5
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2017-02-22 09:40:58 -05:00
Andreas Jaeger
d4f58113f9 Test that glossary is sorted
Test that glossary entries are sorted and fail the niceness test if not.

Sort those entries that were not sorted.

Change-Id: I40eec5e6132bd79899456de505406ac2fa4ca32f
2016-11-14 16:43:19 +01:00
Matthew Kassawara
26ade188b3 [networking] Reorganize deployment examples
Major reorganization and rewriting of deployment examples to
use "building blocks" that enable the audience to begin with
a simple architecture and add complexity as necessary. Also
reduces duplication of content.

Configuration and commands reference Mitaka to ease backporting
to Mitaka. After merge, I will submit another patch to update
the configuration and commands for Newton.

Macvtap content needs a significant rewrite to integrate
better with the deployment examples. Will address in Ocata.

Change-Id: I2ae95d726aa053a0f30507a3e68907ac56296e6b
backport: mitaka
2016-10-06 12:32:20 -06:00
gengchc2
c4ced7f919 Update flake8 ignore list
In hacking > 0.10.0, there is no E123 and E125, so this commit to
delete them.

Change-Id: I21ed6315821d3dbf98b03042225251c400147cd4
2016-09-28 10:48:08 +08:00
xianming mao
6ce13e315c Modify the config message in tox.ini
There have no direction openstack/common in this project,so
we can delete it.

And the H803 has been deprecated,so we can delete it either.
More details:https://github.com/openstack-dev/hacking/blob/master/setup.cfg

Change-Id: If9bbdad02f836128909525f09c0f77ac0a6effd2
2016-09-25 16:28:39 +08:00
Andreas Jaeger
e161549f04 Do not delete releasenotes before building
With the options given to sphinx, we regenerate releasenotes , there's
no need to rm -rf the content before - it will only break a proposed
way to translate the content.

Change-Id: I17d72f3561c25c0d7dd7f1c9ec09c57c1e8df798
2016-09-19 09:19:21 +02:00
Andreas Jaeger
4339c071bb Update for openstack-doc-tools 1.0.0
Require the new release and remove openstack-doc-test from
checkniceness, this was only needed for docbook XML files.
The command does not exist anymore.

Change-Id: I88c39f3c85935300c0377c028997f5009969b373
2016-08-22 18:10:19 +02:00
KATO Tomoyuki
b80b303178 remove unused path from checkniceness ignore-path
Change-Id: I7366882be2c45eece3608bc7bb1c00507822b559
2016-07-21 23:52:54 +09:00
Andreas Jaeger
5fe5fedd48 Revert "Add zuul-cloner-test environment"
Testing was done successfully.

This reverts commit d50faa7acdb3dd91194122ebfe21df5e9809144c.

Change-Id: Ifa339785f1e9d73ee45ffb91faad90f5db2d4143
2016-07-17 14:06:27 +00:00
Andreas Jaeger
d50faa7acd Add zuul-cloner-test environment
This is needed for some OpenStack CI testing, it will be removed once
the job is working correctly.

Related Change: I7343d54185a896b847d6340532bdab22465e98f0
Change-Id: Ib6d45031866790ee73000cf514e1263a7e8dff69
2016-07-15 08:17:43 +02:00
KATO Tomoyuki
31b31410f9 Factor out Install Guide for Debian with debconf
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
2016-05-19 17:37:53 +09:00
KATO Tomoyuki
07396af70a Remove work around for fix released problem
Change-Id: I7478cc99adec8c1f421c043fd2daaba6ef4ca913
2016-05-05 19:59:27 +09:00
Andreas Jaeger
48b407ef99 Cleanup tox environment
Since we do not build DocBook XML anymore, we have removed the jobs for
this and thus can remove the support for these also from tox.ini.

checksyntax, checklinks and checkdeletions are DocBook XML only targets,
so remove them.

Change-Id: Iaa663c03fd6e2976208e20ba03dbab4d8d82b2ce
Depends-On: I9f5944eb9db06fe2ff9088f22048c198b2921237
2016-05-02 10:05:41 +02:00
Andreas Jaeger
ed100316b4 Convert glossary to RST
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
2016-05-02 09:20:30 +02:00
Andreas Jaeger
6a01aa42d1 Prepare releasenotes for publishing
Move release notes into releasenotes and add tox target so that
infra scripts will publish them to
docs.openstack.org/releasenotes/openstack-manuals

Infra change: Icbe135e37c78e0a3a1c6d3243f7128c0b881325d

Note that the directory layout here is this way on purpose - we want to
reuse the same jobs other repos use, just the difference is we're not
using reno for this.

Change-Id: I00a53d8b3d9bef28b480be22af2e6647fa26448a
2016-03-18 12:46:15 +01:00
zhangguoqing
ee6853461a [install-guides] make pipeline configuration actual one line
"pipeline" must be only one line in ceilometer-swift.rst, which it
easy to misguide deployer to four lines before this patch set.

Change-Id: I2c2af5d026b335394660780913c9bbb2392e3b7c
2016-03-17 22:52:18 +08:00
KATO Tomoyuki
f6ce6bd328 Rename common-rst to common
Keep the sync target repo path "common-rst" as of now.

Change-Id: I552d2c0a422c4824632b11fa273629004b889306
2016-02-11 21:18:59 +09:00
Matthew Kassawara
6e74e65392 [network] Preparation for Liberty/Mitaka updates
Prepare the networking guide for Liberty/Mitaka updates as
follows:

1) Change "legacy" to "classic" to provide a more positive
   connotation of such scenarios. Legacy should refer to
   nova-network.
2) Replace underscore with hyphen in filenames to meet
   conventions.
3) Replace :doc: with :ref: to minimize impact of future
   file renames.

Change-Id: I95bdd84b4a01cd9cbd06cad66821ad810295394f
backport: Liberty
2016-01-14 06:58:29 -07:00
chenghang
fb75840d3c Fix typo in tox.ini
tox.ini Line:133
lineos -> linenos

Change-Id: If2b19b065bec2c1b6ee9e30ffb75fa03e9bcb0a9
2015-12-31 10:51:11 +00:00
Andreas Jaeger
cbeb4d5c5b Revert "Add reno for release-notes"
As discussed via email, let's do this on a smaller scale.

This reverts commit 9432a6da0cc341a879bc6f4ac48380248355e77a.

Change-Id: I27e9cd06c5d69917abe452e873873683e10c282a
2015-11-10 14:49:13 +00:00
Andreas Jaeger
9432a6da0c Add reno for release-notes
Add renote to automatically generate release notes - the same way other
OpenStack projects do it.
For details see
http://lists.openstack.org/pipermail/openstack-dev/2015-November/078301.html

Change-Id: Iac8f34ae3490b7788c989b17be3e6a616e65c676
2015-11-07 17:34:29 +01:00
Christian Berendt
08b31a9c18 tox: add a generic environment to build a RST guide
With this environment it is possible to build a single RST guide with
the following common: tox -e build -- NAME

E.g. to build the contributor guide run the following command:

tox -e build -- contributor-guide

Change-Id: I94cf504eece14b2b8d2734cb5b4c16a1b409026f
2015-10-08 19:30:11 +02:00
Andreas Jaeger
34823b69ff Enhance generatepot-rst for reuse
Enhance file so that it can be used by other documentation repos as
well.
Update invocation of it.

Change-Id: I93a6d8ccb8c314c0961b87a239462183712cdd26
2015-10-06 20:11:17 +02:00
Andreas Jaeger
8750c28ab1 Set giturl for openstackdocstheme 1.2.3
Also whitelist conf.py by flake8.

Co-Authored-By: Bernd Bausch <berndbausch@gmail.com>
Change-Id: I9899fde4586a44aa4dd4e48402a3f25933bebc4a
2015-10-06 13:45:57 +02:00
Christian Berendt
721139f880 Add environments to build install guides individually
Change-Id: I0741098b99c4d05cb38cf38a604f549f21a49916
2015-09-16 19:36:20 +02:00
Andreas Jaeger
0c8798bf2d Add linkcheck for RST
Check RST files for valid links.

This is a separte target for now to evaluate how useful it is.
Whitelist build.opensuse.org URL for user-guide.
Remove also checklang from default tox invocation since it's not needed
to run by default.

Change-Id: I6c275518b9e55ab3b6bcea52894ea851924bee94
2015-08-25 06:29:37 +02:00
Sam Stoelinga
27abd34177 Add advanced SR-IOV section to networking guide
Co-Authored-By: Moshe Levi <moshele@mellanox.com>

Closes-bug: #1476242

Change-Id: Idf85af2153da2ce51383542f4c2616c62b56bafb
2015-08-22 01:23:49 +08:00
Andreas Jaeger
0a4e814f50 Gate at RST line length of 79 chars
With this patch, the RST files have no line longer than 79 chars -
as discussed on the docs mailing list - and we
can gate on it. Previously this limit was 100 chars.

Change-Id: I23f550db81e9264649d0444f5f1ba1be0d6d343d
2015-06-20 21:17:26 +02:00
Jenkins
6621f65d32 Merge "[install-guide-rst] Set up conditionals for distros" 2015-06-18 07:26:59 +00:00
Andreas Jaeger
52bbdc220f [install-guide-rst] Set up conditionals for distros
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
2015-06-17 20:37:05 +02:00
Andreas Jaeger
21d93118f0 Avoid really overlooooooooong lines in RST
We aim to have no lines longer than 79 characters, enable the line
checking niceness check but set it to 100 as current maximum.

Convert files that fail this line length.

Convert one table to a definition list, convert two tables to use
list-table directive.

Change-Id: I8d0a95cc1c8e72965b3e0e69445e7b2bc6d77f0f
2015-06-12 19:28:23 +02:00
Andreas Jaeger
c2cac00294 Cleanup builds
Remove separate build-user-guides.sh and create a new build-all-rst.sh
tool.

Remove networking tox environment, since the RST guides share files, we
should always build them together using the docs tox environment.

Change-Id: I7ef98ca5e134096e14c79d58b0fc62a07747e471
2015-05-29 17:10:41 +00:00
Andreas Jaeger
f69c489346 User Guides: Enable translations
openstack-doc-tools 0.28 contains a fix for translation of RST guides
and the User Guides. Require that version and enable the User Guides for
translation.

Add building of glossary for translation environments to tox.ini.

Change-Id: I645bf98b68603811a9a978e508d1f492e44da738
2015-05-13 22:13:41 +02:00
Andreas Jaeger
1713dabf56 Unify checkbuild and publishdocs
The two tox environments were large and mostly duplicated, use a shell
script instead and use the build-rst.sh script to simplify building and
publishing.

For copying to /kilo, use the tools/copy-to-branch.sh script instead of
the simple commands since that is more robust. Merge that script into
this script, no need for a second script.

Update requirements: We need 0.27 at least to not have to delete the
Debian Install Guide, sync also pbr with global-requirements.txt.

Change-Id: Ieba77b4e3d0bbe58db041206d9725c523b3bb43a
2015-05-13 20:01:56 +02:00
Andreas Jaeger
2e1b8d1d32 Move User Guides into separate directories
Separate User Guides cleanly, there's little benefit in having them in
one directory and it causes quite some strange sphinx challenges.

Temporarily disable translation of the guides since first a new release
of openstack-doc-tools is needed.

Partial implements bp reorganise-user-guides

Change-Id: I9e41bb67397c5bc26c1940f67387f3e42a9c5cbc
2015-05-12 11:56:08 +02:00
Andreas Jaeger
2dd2472967 Move RST Glossary to common-rst
Build glossary only once and put it into common-rst directory so that
all RST guides can use it.

Change-Id: I2d3acf25a3af48349b7c10b7e9fea86d5f16444e
2015-05-12 11:56:08 +02:00
Andreas Jaeger
16f7398bef Do not fail on publishing command
If no documents are published to /draft, the "cp -a" would fail, rewrite
it so that it always succeeds.

If any command fails, nothing gets uploaded ;(

Change-Id: Ib9c6254504f868fd1a8eb772d5df9651448adc42
2015-05-09 20:40:54 +02:00
Andreas Jaeger
dab9cf0dbe Publish draft language guides under /draft
Publish draft documentation on docs.openstack.org/draft.

For now these are all Install Guides and the French Image Guide.

Update wiki pages for new links.

Partially implements bp draft-publishing

Change-Id: I319a52f7bc9982ab172fbbbaeb0a22a7642b5b07
2015-05-06 20:32:44 +02:00
Andreas Jaeger
5e09a5b4cc Remove obsolete Networking DocBook XML files
Since we're publishing now the RST files, it's time to remove
the XML files.

Change-Id: Ia8ba03fc56590951036ee86cda96d153f90614b4
2015-05-01 11:38:01 +02:00