Update docs job
publish-openstack-sphinx-docs jobs are obsolete since some time, use the newer publish-openstack-docs-pti jobs instead. Update tox.ini to use the PTI way of building docs. Fix all RST errors found so that this builds cleanly now. Change-Id: I61dd9c0a2caa1b2e0c5e71c609091b7bb356520a
This commit is contained in:
Andreas Jaeger
parent
8fd845a7c7
commit
ccdcae52be
|
|
@ -1,3 +1,3 @@
|
||||||
- project:
|
- project:
|
||||||
templates:
|
templates:
|
||||||
- publish-openstack-sphinx-docs
|
- publish-openstack-docs-pti
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
.. _release_notes_17.02
|
.. _release_notes_17.02:
|
||||||
|
|
||||||
=====
|
=====
|
||||||
17.02
|
17.02
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
.. _release_notes_17.08
|
.. _release_notes_17.08:
|
||||||
|
|
||||||
=====
|
=====
|
||||||
17.08
|
17.08
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
.. _release_notes_17.11
|
.. _release_notes_17.11:
|
||||||
|
|
||||||
=====
|
=====
|
||||||
17.11
|
17.11
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
.. _release_notes_1802
|
.. _release_notes_1802:
|
||||||
|
|
||||||
=====
|
=====
|
||||||
18.02
|
18.02
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
.. _release_notes_1805
|
.. _release_notes_1805:
|
||||||
|
|
||||||
=====
|
=====
|
||||||
18.05
|
18.05
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
.. _release_notes_18.08
|
.. _release_notes_18.08:
|
||||||
|
|
||||||
=====
|
=====
|
||||||
18.08
|
18.08
|
||||||
|
|
@ -204,7 +204,8 @@ https://bugs.launchpad.net/glance/+bug/1789748
|
||||||
The workaround is to manually set the read ACL on the glance container
|
The workaround is to manually set the read ACL on the glance container
|
||||||
|
|
||||||
.. code:: bash
|
.. code:: bash
|
||||||
swift post glance --read-acl ".r:*,.rlistings"
|
|
||||||
|
swift post glance --read-acl ".r:*,.rlistings"
|
||||||
|
|
||||||
Two, the glance-simplestreams-sync charm relies on simplestreams which is not yet glance v2 aware:
|
Two, the glance-simplestreams-sync charm relies on simplestreams which is not yet glance v2 aware:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
.. _release_notes_18.11
|
.. _release_notes_18.11:
|
||||||
|
|
||||||
=====
|
=====
|
||||||
18.11
|
18.11
|
||||||
|
|
@ -193,7 +193,10 @@ One, when using swift store as a back end for glance, glance fails to set the AC
|
||||||
https://bugs.launchpad.net/glance/+bug/1789748
|
https://bugs.launchpad.net/glance/+bug/1789748
|
||||||
|
|
||||||
The workaround is to manually set the read ACL on the glance container
|
The workaround is to manually set the read ACL on the glance container
|
||||||
swift post glance --read-acl ".r:*,.rlistings"
|
|
||||||
|
.. code:: bash
|
||||||
|
|
||||||
|
swift post glance --read-acl ".r:*,.rlistings"
|
||||||
|
|
||||||
Two, the glance-simplestreams-sync charm relies on simplestreams which is not yet glance v2 aware:
|
Two, the glance-simplestreams-sync charm relies on simplestreams which is not yet glance v2 aware:
|
||||||
https://bugs.launchpad.net/simplestreams/+bug/1790904
|
https://bugs.launchpad.net/simplestreams/+bug/1790904
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
.. _release_notes_19.04
|
.. _release_notes_19.04:
|
||||||
|
|
||||||
=====
|
=====
|
||||||
19.04
|
19.04
|
||||||
|
|
@ -87,7 +87,7 @@ New Charm Features
|
||||||
==================
|
==================
|
||||||
|
|
||||||
With each new feature, there is a corresponding example bundle in the form of
|
With each new feature, there is a corresponding example bundle in the form of
|
||||||
a test bundle, and/or a `charm deployment guide <https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/>`_
|
a test bundle, and/or a `charm deployment guide <https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/>`__
|
||||||
section which details the use of the feature. For example test bundles, see the
|
section which details the use of the feature. For example test bundles, see the
|
||||||
src/tests/bundles/ directory within the relevant charm repository.
|
src/tests/bundles/ directory within the relevant charm repository.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ layers.yaml
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|
||||||
The **src/layers.yaml** file defines what layers and interfaces will be imported
|
The **src/layers.yaml** file defines what layers and interfaces will be imported
|
||||||
and included in the charm when the charm is built. See the `OpenStack Layers`_
|
and included in the charm when the charm is built. See the `Openstack Layers`_
|
||||||
section and `OpenStack Interfaces`_ section below. If additional interfaces or
|
section and `OpenStack Interfaces`_ section below. If additional interfaces or
|
||||||
layers add them to the **includes** list within **src/layers.yaml**.
|
layers add them to the **includes** list within **src/layers.yaml**.
|
||||||
|
|
||||||
|
|
@ -60,8 +60,6 @@ describes the charm and how it relates to other charms. This is also
|
||||||
constructed from each layer that defines a metadata.yaml
|
constructed from each layer that defines a metadata.yaml
|
||||||
|
|
||||||
|
|
||||||
.. _`OpenStack Layers`:
|
|
||||||
|
|
||||||
OpenStack Layers
|
OpenStack Layers
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
|
@ -74,8 +72,6 @@ Juju hooks and runs the charms.reactive.main loop for them. It also bootstraps
|
||||||
the charm-helpers and charms.reactive libraries and all of their dependencies
|
the charm-helpers and charms.reactive libraries and all of their dependencies
|
||||||
for use by the charm.
|
for use by the charm.
|
||||||
|
|
||||||
.. _`OpenStack Layer`:
|
|
||||||
|
|
||||||
OpenStack Layer
|
OpenStack Layer
|
||||||
~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
release-policy.rst
|
|
||||||
|
|
@ -68,7 +68,10 @@ copyright = Markup(u'%s, OpenStack Contributors '
|
||||||
|
|
||||||
# List of patterns, relative to source directory, that match files and
|
# List of patterns, relative to source directory, that match files and
|
||||||
# directories to ignore when looking for source files.
|
# directories to ignore when looking for source files.
|
||||||
exclude_patterns = ['_build']
|
exclude_patterns = [
|
||||||
|
'_build',
|
||||||
|
'release-notes-template.rst'
|
||||||
|
]
|
||||||
|
|
||||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||||
#default_role = None
|
#default_role = None
|
||||||
|
|
|
||||||
|
|
@ -41,7 +41,7 @@ During the charm generation charm tools asks a few questions about the charm.
|
||||||
What is the earliest OpenStack release this charm is compatible with? liberty
|
What is the earliest OpenStack release this charm is compatible with? liberty
|
||||||
What packages should this charm install (space separated list)?
|
What packages should this charm install (space separated list)?
|
||||||
|
|
||||||
.. _`Build Charm`:
|
.. _`build_sdn_charm`:
|
||||||
|
|
||||||
Build Charm
|
Build Charm
|
||||||
===========
|
===========
|
||||||
|
|
@ -104,7 +104,7 @@ setting in nova.conf.
|
||||||
})
|
})
|
||||||
|
|
||||||
This tells the charm to send that configuration to the principle where the
|
This tells the charm to send that configuration to the principle where the
|
||||||
**neutron-plugin.connected** event has been raised. Then repeat the `Build Charm`_
|
**neutron-plugin.connected** event has been raised. Then repeat the `build_sdn_charm`_
|
||||||
steps.
|
steps.
|
||||||
|
|
||||||
Deploy Update
|
Deploy Update
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
.. _release_notes_<CHARM_RELEASE>
|
.. _release_notes_<CHARM_RELEASE>:
|
||||||
|
|
||||||
**** This is a template file for future release notes and its contents should not be linked or referenced. Use actual release notes instead. ****
|
**** This is a template file for future release notes and its contents should not be linked or referenced. Use actual release notes instead. ****
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
release-notes.rst
|
|
||||||
Loading…
Reference in New Issue