From f76dc6224f396351d7b3dee84263ea50c3648439 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Mon, 20 Nov 2017 10:59:47 -0500 Subject: [PATCH] restore stable/mitaka build Remove obsolete niceness checking tools from tox settings (doc8 throws an encoding error on one of the old files and openstack-doc-test doesn't seem to exist at all any more). Restore the builds for all guides, but place the output under the mitaka directory. This effectively makes these mitaka-specific versions of the guides. Links to the guides on the /mitaka landing page need to be updated separately on master. Change remote include directives from stable/mitaka to mitaka-eol. Add .zuul.yaml, copied from stable/newton, and the required playbook for running the builds in tox. Add "linters" alias environment in tox.ini since that is now what the test jobs expect. Change-Id: Ifc667dd46d2282c8f843600d10ae988a8a281041 Signed-off-by: Doug Hellmann --- .zuul.yaml | 49 +++++++++++++++++++ ...ock-storage-sample-configuration-files.rst | 6 +-- .../source/compute/api-paste.ini.rst | 2 +- .../source/compute/policy.json.rst | 2 +- .../source/compute/rootwrap.conf.rst | 2 +- .../identity/sample-configuration-files.rst | 8 +-- .../image-service/glance-api-paste.ini.rst | 2 +- .../source/image-service/glance-api.conf.rst | 2 +- .../image-service/glance-cache.conf.rst | 2 +- .../image-service/glance-manage.conf.rst | 2 +- .../glance-registry-paste.ini.rst | 2 +- .../image-service/glance-registry.conf.rst | 2 +- .../image-service/glance-scrubber.conf.rst | 2 +- .../image-service/glance-swift.conf.rst | 2 +- .../image-service/ovf-metadata.json.rst | 2 +- .../source/image-service/policy.json.rst | 2 +- .../property-protections-policies.conf.rst | 2 +- .../property-protections-roles.conf.rst | 2 +- .../networking/sample-configuration-files.rst | 6 +-- .../source/object-storage/account-server.rst | 2 +- .../object-storage/container-reconciler.rst | 2 +- .../object-storage/container-server.rst | 2 +- .../object-storage/container-sync-realms.rst | 2 +- .../source/object-storage/object-expirer.rst | 2 +- .../source/object-storage/object-server.rst | 2 +- .../source/object-storage/proxy-server.rst | 2 +- .../telemetry/sample-configuration-files.rst | 8 +-- .../locale/ja/LC_MESSAGES/install-guide.po | 2 +- .../locale/ko_KR/LC_MESSAGES/install-guide.po | 2 +- .../locale/zh_CN/LC_MESSAGES/install-guide.po | 2 +- .../source/swift-controller-install.rst | 4 +- .../source/swift-finalize-installation.rst | 2 +- .../source/swift-storage-install.rst | 6 +-- doc/install-guide/source/trove-install.rst | 2 +- playbooks/build-manuals-tox/post.yaml | 5 ++ tools/build-all-rst.sh | 10 ++-- tox.ini | 6 ++- 37 files changed, 108 insertions(+), 54 deletions(-) create mode 100644 .zuul.yaml create mode 100644 playbooks/build-manuals-tox/post.yaml diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 0000000000..02cf809ff6 --- /dev/null +++ b/.zuul.yaml @@ -0,0 +1,49 @@ +# Shared Zuul v3 definitions for OpenStack CI. + +# These jobs are used in api-site, openstack-manuals, and security-doc +# repositories. + +- job: + name: build-tox-manuals + description: | + Base job to build manual related documents. These build jobs + invoke a tox command and expect the published content to be in + publish-docs directory. This content is published on the root of + the website. + + Note that this build job does not create a root-marker file, + this has to be done by scripts called from tox. + parent: openstack-tox + success-url: publish-docs/ + post-run: playbooks/build-manuals-tox/post.yaml + roles: + - zuul: openstack-infra/zuul-jobs + +- job: + name: build-tox-manuals-checkbuild + parent: build-tox-manuals + vars: + tox_envlist: checkbuild + +# Templates to easily group jobs. +- project-template: + name: openstack-manuals-jobs + description: | + Runs jobs for non-translated documents. + check: + jobs: + - openstack-tox-linters + - build-tox-manuals-checkbuild + gate: + jobs: + - openstack-tox-linters + - build-tox-manuals-checkbuild + post: + jobs: + - publish-openstack-manuals + +# Configuration for this repository, determines which jobs to run. +- project: + name: openstack/openstack-manuals + templates: + - openstack-manuals-jobs diff --git a/doc/config-reference/source/block-storage/block-storage-sample-configuration-files.rst b/doc/config-reference/source/block-storage/block-storage-sample-configuration-files.rst index ed32982bb6..8501928da9 100644 --- a/doc/config-reference/source/block-storage/block-storage-sample-configuration-files.rst +++ b/doc/config-reference/source/block-storage/block-storage-sample-configuration-files.rst @@ -29,7 +29,7 @@ service. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/api-paste.ini?h=stable/mitaka + https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/api-paste.ini?h=mitaka-eol policy.json ~~~~~~~~~~~ @@ -39,7 +39,7 @@ to the Block Storage service. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/policy.json?h=stable/mitaka + https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/policy.json?h=mitaka-eol rootwrap.conf ~~~~~~~~~~~~~ @@ -50,4 +50,4 @@ privileges to those of the root user. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/rootwrap.conf?h=stable/mitaka + https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/rootwrap.conf?h=mitaka-eol diff --git a/doc/config-reference/source/compute/api-paste.ini.rst b/doc/config-reference/source/compute/api-paste.ini.rst index bd74274beb..108b94f3bc 100644 --- a/doc/config-reference/source/compute/api-paste.ini.rst +++ b/doc/config-reference/source/compute/api-paste.ini.rst @@ -7,4 +7,4 @@ The Compute service stores its API configuration settings in the .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/api-paste.ini?h=stable/mitaka + https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/api-paste.ini?h=mitaka-eol diff --git a/doc/config-reference/source/compute/policy.json.rst b/doc/config-reference/source/compute/policy.json.rst index 40eae7264d..4927ab4470 100644 --- a/doc/config-reference/source/compute/policy.json.rst +++ b/doc/config-reference/source/compute/policy.json.rst @@ -7,4 +7,4 @@ that apply to the Compute service. .. remote-code-block:: json - https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/policy.json?h=stable/mitaka + https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/policy.json?h=mitaka-eol diff --git a/doc/config-reference/source/compute/rootwrap.conf.rst b/doc/config-reference/source/compute/rootwrap.conf.rst index ecf0c5033b..e399f20684 100644 --- a/doc/config-reference/source/compute/rootwrap.conf.rst +++ b/doc/config-reference/source/compute/rootwrap.conf.rst @@ -12,4 +12,4 @@ to sudo only. Configure the ``disable_rootwrap`` option in the .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/rootwrap.conf?h=stable/mitaka + https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/rootwrap.conf?h=mitaka-eol diff --git a/doc/config-reference/source/identity/sample-configuration-files.rst b/doc/config-reference/source/identity/sample-configuration-files.rst index ea5ad0b390..979d2e718b 100644 --- a/doc/config-reference/source/identity/sample-configuration-files.rst +++ b/doc/config-reference/source/identity/sample-configuration-files.rst @@ -13,7 +13,7 @@ options: .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone.conf.sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone.conf.sample?h=mitaka-eol keystone-paste.ini ~~~~~~~~~~~~~~~~~~ @@ -23,7 +23,7 @@ Interface (WSGI) middleware pipeline for the Identity service: .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone-paste.ini?h=stable/mitaka + https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone-paste.ini?h=mitaka-eol logging.conf ~~~~~~~~~~~~ @@ -36,7 +36,7 @@ For details, see the `Python logging module documentation .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/keystone/plain/etc/logging.conf.sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/keystone/plain/etc/logging.conf.sample?h=mitaka-eol policy.json ~~~~~~~~~~~ @@ -46,4 +46,4 @@ the Identity service: .. remote-code-block:: json - https://git.openstack.org/cgit/openstack/keystone/plain/etc/policy.json?h=stable/mitaka + https://git.openstack.org/cgit/openstack/keystone/plain/etc/policy.json?h=mitaka-eol diff --git a/doc/config-reference/source/image-service/glance-api-paste.ini.rst b/doc/config-reference/source/image-service/glance-api-paste.ini.rst index f6b6a28af6..99c70b1e1e 100644 --- a/doc/config-reference/source/image-service/glance-api-paste.ini.rst +++ b/doc/config-reference/source/image-service/glance-api-paste.ini.rst @@ -9,4 +9,4 @@ You should not need to modify this file. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api-paste.ini?h=stable/mitaka + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api-paste.ini?h=mitaka-eol diff --git a/doc/config-reference/source/image-service/glance-api.conf.rst b/doc/config-reference/source/image-service/glance-api.conf.rst index 5239fa9f5f..54c4f2aac1 100644 --- a/doc/config-reference/source/image-service/glance-api.conf.rst +++ b/doc/config-reference/source/image-service/glance-api.conf.rst @@ -9,4 +9,4 @@ This file must be modified after installation. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api.conf?h=stable/mitaka + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api.conf?h=mitaka-eol diff --git a/doc/config-reference/source/image-service/glance-cache.conf.rst b/doc/config-reference/source/image-service/glance-cache.conf.rst index 62b26dddf4..4597e25269 100644 --- a/doc/config-reference/source/image-service/glance-cache.conf.rst +++ b/doc/config-reference/source/image-service/glance-cache.conf.rst @@ -7,4 +7,4 @@ are found in the ``glance-cache.conf`` file. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-cache.conf?h=stable/mitaka + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-cache.conf?h=mitaka-eol diff --git a/doc/config-reference/source/image-service/glance-manage.conf.rst b/doc/config-reference/source/image-service/glance-manage.conf.rst index 99c71378c5..1c6285379b 100644 --- a/doc/config-reference/source/image-service/glance-manage.conf.rst +++ b/doc/config-reference/source/image-service/glance-manage.conf.rst @@ -15,4 +15,4 @@ are found in the ``glance-manage.conf`` file. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-manage.conf?h=stable/mitaka + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-manage.conf?h=mitaka-eol diff --git a/doc/config-reference/source/image-service/glance-registry-paste.ini.rst b/doc/config-reference/source/image-service/glance-registry-paste.ini.rst index 03357bb5cf..e29c4c93ef 100644 --- a/doc/config-reference/source/image-service/glance-registry-paste.ini.rst +++ b/doc/config-reference/source/image-service/glance-registry-paste.ini.rst @@ -7,4 +7,4 @@ The Image service's middleware pipeline for its registry is found in the .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry-paste.ini?h=stable/mitaka + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry-paste.ini?h=mitaka-eol diff --git a/doc/config-reference/source/image-service/glance-registry.conf.rst b/doc/config-reference/source/image-service/glance-registry.conf.rst index 414de2ab1c..be12c01978 100644 --- a/doc/config-reference/source/image-service/glance-registry.conf.rst +++ b/doc/config-reference/source/image-service/glance-registry.conf.rst @@ -9,4 +9,4 @@ This file must be modified after installation. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry.conf?h=stable/mitaka + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry.conf?h=mitaka-eol diff --git a/doc/config-reference/source/image-service/glance-scrubber.conf.rst b/doc/config-reference/source/image-service/glance-scrubber.conf.rst index 23f80bdf1c..7baf728917 100644 --- a/doc/config-reference/source/image-service/glance-scrubber.conf.rst +++ b/doc/config-reference/source/image-service/glance-scrubber.conf.rst @@ -8,4 +8,4 @@ deleted. Its configuration is stored in the ``glance-scrubber.conf`` file. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-scrubber.conf?h=stable/mitaka + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-scrubber.conf?h=mitaka-eol diff --git a/doc/config-reference/source/image-service/glance-swift.conf.rst b/doc/config-reference/source/image-service/glance-swift.conf.rst index e01107e3b4..76028c405a 100644 --- a/doc/config-reference/source/image-service/glance-swift.conf.rst +++ b/doc/config-reference/source/image-service/glance-swift.conf.rst @@ -4,4 +4,4 @@ glance-swift.conf .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-swift.conf.sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-swift.conf.sample?h=mitaka-eol diff --git a/doc/config-reference/source/image-service/ovf-metadata.json.rst b/doc/config-reference/source/image-service/ovf-metadata.json.rst index fe64b5926a..4c467b57e9 100644 --- a/doc/config-reference/source/image-service/ovf-metadata.json.rst +++ b/doc/config-reference/source/image-service/ovf-metadata.json.rst @@ -11,4 +11,4 @@ from the ``CIM_ProcessorAllocationSettingData`` namespace, .. remote-code-block:: json - https://git.openstack.org/cgit/openstack/glance/plain/etc/ovf-metadata.json.sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/glance/plain/etc/ovf-metadata.json.sample?h=mitaka-eol diff --git a/doc/config-reference/source/image-service/policy.json.rst b/doc/config-reference/source/image-service/policy.json.rst index 9def43e923..9543907ceb 100644 --- a/doc/config-reference/source/image-service/policy.json.rst +++ b/doc/config-reference/source/image-service/policy.json.rst @@ -7,4 +7,4 @@ apply to the Image service. .. remote-code-block:: json - https://git.openstack.org/cgit/openstack/glance/plain/etc/policy.json?h=stable/mitaka + https://git.openstack.org/cgit/openstack/glance/plain/etc/policy.json?h=mitaka-eol diff --git a/doc/config-reference/source/image-service/property-protections-policies.conf.rst b/doc/config-reference/source/image-service/property-protections-policies.conf.rst index 43f5b02597..deb950a7b2 100644 --- a/doc/config-reference/source/image-service/property-protections-policies.conf.rst +++ b/doc/config-reference/source/image-service/property-protections-policies.conf.rst @@ -4,4 +4,4 @@ property-protections-policies.conf .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/property-protections-policies.conf.sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/glance/plain/etc/property-protections-policies.conf.sample?h=mitaka-eol diff --git a/doc/config-reference/source/image-service/property-protections-roles.conf.rst b/doc/config-reference/source/image-service/property-protections-roles.conf.rst index 8017b9d41c..139f616178 100644 --- a/doc/config-reference/source/image-service/property-protections-roles.conf.rst +++ b/doc/config-reference/source/image-service/property-protections-roles.conf.rst @@ -4,4 +4,4 @@ property-protections-roles.conf .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/glance/plain/etc/property-protections-roles.conf.sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/glance/plain/etc/property-protections-roles.conf.sample?h=mitaka-eol diff --git a/doc/config-reference/source/networking/sample-configuration-files.rst b/doc/config-reference/source/networking/sample-configuration-files.rst index ad3a6fd9ec..88e9021bcf 100644 --- a/doc/config-reference/source/networking/sample-configuration-files.rst +++ b/doc/config-reference/source/networking/sample-configuration-files.rst @@ -29,7 +29,7 @@ gateway interface (WSGI). .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/neutron/plain/etc/api-paste.ini?h=stable/mitaka + https://git.openstack.org/cgit/openstack/neutron/plain/etc/api-paste.ini?h=mitaka-eol policy.json ~~~~~~~~~~~ @@ -38,7 +38,7 @@ The ``policy.json`` defines API access policy. .. remote-code-block:: json - https://git.openstack.org/cgit/openstack/neutron/plain/etc/policy.json?h=stable/mitaka + https://git.openstack.org/cgit/openstack/neutron/plain/etc/policy.json?h=mitaka-eol rootwrap.conf ~~~~~~~~~~~~~ @@ -48,7 +48,7 @@ that require privilege escalation to execute. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/neutron/plain/etc/rootwrap.conf?h=stable/mitaka + https://git.openstack.org/cgit/openstack/neutron/plain/etc/rootwrap.conf?h=mitaka-eol Reference architecture plug-ins and agents ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/config-reference/source/object-storage/account-server.rst b/doc/config-reference/source/object-storage/account-server.rst index 6b7c50aa1d..a0ded7c5c4 100644 --- a/doc/config-reference/source/object-storage/account-server.rst +++ b/doc/config-reference/source/object-storage/account-server.rst @@ -22,4 +22,4 @@ Sample account server configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/account-server.conf-sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/swift/plain/etc/account-server.conf-sample?h=mitaka-eol diff --git a/doc/config-reference/source/object-storage/container-reconciler.rst b/doc/config-reference/source/object-storage/container-reconciler.rst index 9f6c61c199..78ec7bf782 100644 --- a/doc/config-reference/source/object-storage/container-reconciler.rst +++ b/doc/config-reference/source/object-storage/container-reconciler.rst @@ -20,4 +20,4 @@ Sample container sync reconciler configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/container-reconciler.conf-sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/swift/plain/etc/container-reconciler.conf-sample?h=mitaka-eol diff --git a/doc/config-reference/source/object-storage/container-server.rst b/doc/config-reference/source/object-storage/container-server.rst index 2d812b1efb..888f4caf40 100644 --- a/doc/config-reference/source/object-storage/container-server.rst +++ b/doc/config-reference/source/object-storage/container-server.rst @@ -23,4 +23,4 @@ Sample container server configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/container-server.conf-sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/swift/plain/etc/container-server.conf-sample?h=mitaka-eol diff --git a/doc/config-reference/source/object-storage/container-sync-realms.rst b/doc/config-reference/source/object-storage/container-sync-realms.rst index 74d5cccc95..e9e0a73c7e 100644 --- a/doc/config-reference/source/object-storage/container-sync-realms.rst +++ b/doc/config-reference/source/object-storage/container-sync-realms.rst @@ -16,4 +16,4 @@ Sample container sync realms configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/container-sync-realms.conf-sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/swift/plain/etc/container-sync-realms.conf-sample?h=mitaka-eol diff --git a/doc/config-reference/source/object-storage/object-expirer.rst b/doc/config-reference/source/object-storage/object-expirer.rst index 1744dec6e0..805914f0f0 100644 --- a/doc/config-reference/source/object-storage/object-expirer.rst +++ b/doc/config-reference/source/object-storage/object-expirer.rst @@ -20,4 +20,4 @@ Sample object expirer configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/object-expirer.conf-sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/swift/plain/etc/object-expirer.conf-sample?h=mitaka-eol diff --git a/doc/config-reference/source/object-storage/object-server.rst b/doc/config-reference/source/object-storage/object-server.rst index 0bd76d302d..fd61f4a701 100644 --- a/doc/config-reference/source/object-storage/object-server.rst +++ b/doc/config-reference/source/object-storage/object-server.rst @@ -22,4 +22,4 @@ Sample object server configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/object-server.conf-sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/swift/plain/etc/object-server.conf-sample?h=mitaka-eol diff --git a/doc/config-reference/source/object-storage/proxy-server.rst b/doc/config-reference/source/object-storage/proxy-server.rst index 55103009ef..21d1359ce2 100644 --- a/doc/config-reference/source/object-storage/proxy-server.rst +++ b/doc/config-reference/source/object-storage/proxy-server.rst @@ -29,4 +29,4 @@ Sample proxy server configuration file .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=mitaka-eol diff --git a/doc/config-reference/source/telemetry/sample-configuration-files.rst b/doc/config-reference/source/telemetry/sample-configuration-files.rst index a6538982b2..1c68867dd9 100644 --- a/doc/config-reference/source/telemetry/sample-configuration-files.rst +++ b/doc/config-reference/source/telemetry/sample-configuration-files.rst @@ -28,7 +28,7 @@ traits that operators may find useful. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_definitions.yaml?h=stable/mitaka + https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_definitions.yaml?h=mitaka-eol pipeline.yaml ~~~~~~~~~~~~~ @@ -42,7 +42,7 @@ generated by the Telemetry module. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/pipeline.yaml?h=stable/mitaka + https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/pipeline.yaml?h=mitaka-eol event_pipeline.yaml ~~~~~~~~~~~~~~~~~~~ @@ -56,7 +56,7 @@ where to publish the events. .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_pipeline.yaml?h=stable/mitaka + https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_pipeline.yaml?h=mitaka-eol policy.json ~~~~~~~~~~~ @@ -66,4 +66,4 @@ to the Telemetry service. .. remote-code-block:: json - https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/policy.json?h=stable/mitaka + https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/policy.json?h=mitaka-eol diff --git a/doc/install-guide/source/locale/ja/LC_MESSAGES/install-guide.po b/doc/install-guide/source/locale/ja/LC_MESSAGES/install-guide.po index b5d4a5a078..c1f09f6c60 100644 --- a/doc/install-guide/source/locale/ja/LC_MESSAGES/install-guide.po +++ b/doc/install-guide/source/locale/ja/LC_MESSAGES/install-guide.po @@ -2523,7 +2523,7 @@ msgid "" "mitaka>`__." msgstr "" "このファイルが存在しない場合は、 `ここ `__ からファイ" +"openstack/trove/plain/etc/trove/api-paste.ini?h=mitaka-eol>`__ からファイ" "ルを取得できます。" msgid "" diff --git a/doc/install-guide/source/locale/ko_KR/LC_MESSAGES/install-guide.po b/doc/install-guide/source/locale/ko_KR/LC_MESSAGES/install-guide.po index 731727d8b9..d9983ef2d9 100644 --- a/doc/install-guide/source/locale/ko_KR/LC_MESSAGES/install-guide.po +++ b/doc/install-guide/source/locale/ko_KR/LC_MESSAGES/install-guide.po @@ -2603,7 +2603,7 @@ msgid "" "mitaka>`__." msgstr "" "만약 해당 파일이 존재하지 않는 경우, 해당 `위치 `__ 로부" +"cgit/openstack/trove/plain/etc/trove/api-paste.ini?h=mitaka-eol>`__ 로부" "터 파일을 가져올 수 있습니다." msgid "" diff --git a/doc/install-guide/source/locale/zh_CN/LC_MESSAGES/install-guide.po b/doc/install-guide/source/locale/zh_CN/LC_MESSAGES/install-guide.po index 8d499ac1c3..899d370c23 100644 --- a/doc/install-guide/source/locale/zh_CN/LC_MESSAGES/install-guide.po +++ b/doc/install-guide/source/locale/zh_CN/LC_MESSAGES/install-guide.po @@ -2267,7 +2267,7 @@ msgid "" "mitaka>`__." msgstr "" "如果文件不存在，你可以从以下这个地址获得它：`__." +"openstack/trove/plain/etc/trove/api-paste.ini?h=mitaka-eol>`__." msgid "" "If the upgrade process includes a new kernel, reboot your host to activate " diff --git a/doc/install-guide/source/swift-controller-install.rst b/doc/install-guide/source/swift-controller-install.rst index 100fb90c62..e09309c8fc 100644 --- a/doc/install-guide/source/swift-controller-install.rst +++ b/doc/install-guide/source/swift-controller-install.rst @@ -174,7 +174,7 @@ Install and configure components .. code-block:: console - # curl -o /etc/swift/proxy-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=stable/mitaka + # curl -o /etc/swift/proxy-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=mitaka-eol .. only:: rdo @@ -183,7 +183,7 @@ Install and configure components .. code-block:: console - # curl -o /etc/swift/proxy-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=stable/mitaka + # curl -o /etc/swift/proxy-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=mitaka-eol .. only:: obs diff --git a/doc/install-guide/source/swift-finalize-installation.rst b/doc/install-guide/source/swift-finalize-installation.rst index 30b2aa9523..9f29734dec 100644 --- a/doc/install-guide/source/swift-finalize-installation.rst +++ b/doc/install-guide/source/swift-finalize-installation.rst @@ -11,7 +11,7 @@ Finalize installation .. code-block:: console # curl -o /etc/swift/swift.conf \ - https://git.openstack.org/cgit/openstack/swift/plain/etc/swift.conf-sample?h=stable/mitaka + https://git.openstack.org/cgit/openstack/swift/plain/etc/swift.conf-sample?h=mitaka-eol #. Edit the ``/etc/swift/swift.conf`` file and complete the following actions: diff --git a/doc/install-guide/source/swift-storage-install.rst b/doc/install-guide/source/swift-storage-install.rst index 1fbe424569..da6fed148c 100644 --- a/doc/install-guide/source/swift-storage-install.rst +++ b/doc/install-guide/source/swift-storage-install.rst @@ -173,9 +173,9 @@ Install and configure components .. code-block:: console - # curl -o /etc/swift/account-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/account-server.conf-sample?h=stable/mitaka - # curl -o /etc/swift/container-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/container-server.conf-sample?h=stable/mitaka - # curl -o /etc/swift/object-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/object-server.conf-sample?h=stable/mitaka + # curl -o /etc/swift/account-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/account-server.conf-sample?h=mitaka-eol + # curl -o /etc/swift/container-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/container-server.conf-sample?h=mitaka-eol + # curl -o /etc/swift/object-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/object-server.conf-sample?h=mitaka-eol 3. .. include:: swift-storage-include1.txt 4. .. include:: swift-storage-include2.txt diff --git a/doc/install-guide/source/trove-install.rst b/doc/install-guide/source/trove-install.rst index c811f61084..ed62472c14 100644 --- a/doc/install-guide/source/trove-install.rst +++ b/doc/install-guide/source/trove-install.rst @@ -235,7 +235,7 @@ Install and configure components 3. Verify that the ``api-paste.ini`` file is present in ``/etc/trove``. If the file is not present, you can get it from this - `location `__. + `location `__. 4. Edit the ``trove.conf`` file so it includes appropriate values for the settings shown below: diff --git a/playbooks/build-manuals-tox/post.yaml b/playbooks/build-manuals-tox/post.yaml new file mode 100644 index 0000000000..75cb086fc5 --- /dev/null +++ b/playbooks/build-manuals-tox/post.yaml @@ -0,0 +1,5 @@ +- hosts: all + roles: + - role: fetch-tox-output + - role: fetch-sphinx-output + sphinx_output_src: "{{ zuul.project.src_dir }}/publish-docs" diff --git a/tools/build-all-rst.sh b/tools/build-all-rst.sh index b34f8da0c9..81e040b571 100755 --- a/tools/build-all-rst.sh +++ b/tools/build-all-rst.sh @@ -9,12 +9,10 @@ if [[ $# > 0 ]] ; then fi fi -# Do not build from stable/mitaka -#for guide in user-guide admin-guide \ -# contributor-guide image-guide arch-design cli-reference; do -# tools/build-rst.sh doc/$guide --build build \ -# --target $guide $LINKCHECK -#done +for guide in user-guide admin-guide cli-reference; do + tools/build-rst.sh doc/$guide --build build \ + --target "mitaka/$guide" $LINKCHECK +done # This marker is needed for infra publishing MARKER_TEXT="Project: $ZUUL_PROJECT Ref: $ZUUL_REFNAME Build: $ZUUL_UUID" diff --git a/tox.ini b/tox.ini index 36cae4600e..f867be1391 100644 --- a/tox.ini +++ b/tox.ini @@ -23,12 +23,14 @@ commands = {toxinidir}/tools/build-all-rst.sh --linkcheck [testenv:checkniceness] +# Will be replaced by linters commands = - openstack-doc-test --check-niceness {posargs} flake8 - doc8 doc bash -c "find doc -type f -regex '.*\.pot?' -print0|xargs -0 -n 1 msgfmt --check-format -o /dev/null" +[testenv:linters] +commands = {[testenv:checkniceness]commands} + [testenv:checkbuild] commands = {toxinidir}/tools/publishdocs.sh build