Commit Graph

43 Commits

Author SHA1 Message Date
Dmitriy Rabotyagov ff76357c81 Switch sphinx language to en
With sphinx release of 5.0.0, they changed default for language variable
to 'en' from None. With that current None valuable is not valid and should
not be used.



Change-Id: I682938bd14db47a50c0cc12e288e5a095565e820
2022-05-30 15:49:20 +02:00
Jonathan Rosser 30e569a288 Fix linter errors
Change-Id: Ibf58d90a3ada97e3cb94165ffad4e07eec1ac89e
2020-10-01 16:40:31 +01:00
Zuul d25e45f379 Merge "Use newer openstackdocstheme and reno versions" 2020-06-05 11:01:32 +00:00
OpenStack Proposal Bot 1c18057ce5 Updated from OpenStack Ansible Tests
Change-Id: Ib0b30c556864c82d3588ed2d8c45edb82f3bf617
2020-06-03 19:02:56 +00:00
Andreas Jaeger 335f931661 Use newer openstackdocstheme and reno versions
The sync from https://review.opendev.org/733244 updated to
openstackdocstheme 2.2.1 and reno 3.1.0 versions.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I9a9c582a6a9a1505b4dfe0095c5d04f9b7cada88
2020-06-03 19:12:27 +02:00
Andreas Jaeger 0618b16995 Update docstheme for style
New version of openstackdocstheme (Victoria+) respects pygments_style.
Since this repo is using now Victoria (master) requirements but has
not branched for Ussuri yet, it uses the new version.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Change-Id: Ia006ee0643dc3fff183643a43a0d65911c0249f0
2020-05-20 18:47:09 +02:00
OpenStack Proposal Bot 30351dc400 Updated from OpenStack Ansible Tests
Change-Id: I2c74de0346d813a1433aae74039eb25ed216e4bd
2020-05-12 18:03:38 +00:00
OpenStack Proposal Bot 003ac4e724 Updated from OpenStack Ansible Tests
Change-Id: Ibbdec2ef360b3734455f138468070348c2c1b824
2020-05-05 13:31:33 +00:00
melissaml 0cab78b0e3 Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Cleanup doc/source/conf.py to remove now obsolete content.

Change-Id: I556824101a67591756fdc98ce70ca20558823cea
2020-04-14 16:25:37 +08:00
Zuul 9893bd696b Merge "Replace git.openstack.org with opendev.org" 2019-12-09 16:44:55 +00:00
OpenStack Proposal Bot a3ff417c80 Updated from OpenStack Ansible Tests
Change-Id: I8b21279dc83bdded9af0e661a61f5c6e2db72d84
2019-11-21 16:33:39 +00:00
Dmitriy Rabotyagov 8bc32e3858 Replace git.openstack.org with opendev.org
This patch replaces git.openstack.org with opendev.org as redirection
from old path was enabled.
Also we change upper constraints url due to [1]

[1] http://lists.openstack.org/pipermail/openstack-discuss/2019-May/006478.html

Depends-On: https://review.opendev.org/693841/
Change-Id: I50c1ce9025bd9b947bfd0cd516eb5b3c0a54e62b
2019-11-14 16:58:29 +00:00
Dmitriy Rabotyagov 9906ecd5bd PDF Documentation Build tox target
This patch adds a `pdf-docs` tox target that will build
PDF versions of our docs. As per the Train community goal:

  https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Add sphinxcontrib-svg2pdfconverter to doc/requirements.txt
to convert our SVGs.

Change-Id: Ia22c65b101f8e4d0a6f671ef25424f8e7779d0db
Story: 2006105
2019-10-18 14:24:46 +03:00
OpenStack Proposal Bot 71e16fca3a Updated from OpenStack Ansible Tests
Change-Id: I448ef664a95b15507212f865c0d78dcccb07c872
2019-08-20 03:05:41 +00:00
xuanyandong 3a492a01d6 Cap sphinx for py2 to match global requirements
Change-Id: I2daf24927787b0d0e148b3402da3003172298b32
2019-05-20 15:56:28 +08:00
Zuul a3c8310a99 Merge "Optimizing the safety of the http link site in project.yaml." 2019-04-16 21:37:07 +00:00
Mohammed Naser 51058b2e97 docs: drop sphinxmark
sphinxmark is no longer compatible with the latest release of Sphinx
which is causing all of our documentation jobs to fail.  This patch
removes it as our current usage of openstacktheme for documentation
already provides watermarks for current branch and notices for which
branch the documentation covers.

Change-Id: If64b0ca044bab88c6f3297c1bce3b44c731f817a
2019-04-04 05:11:51 +00:00
zhouxinyong 1e182044de Optimizing the safety of the http link site in project.yaml.
Change-Id: I1efcae5069ff5b87f86cb3747dbbc0b138296f3c
2018-11-14 00:42:43 +08:00
Jesse Pretorius 1d4b2fd49e Remove database configuration
Ceilometer no longer requires or supports a database. Instead
it now forwards everything it collects to the message queue
for collection by the other Telemetry services.

Change-Id: Ib8cb1ca3e0ef81c16a6483d20705fa3b237bbc48
2018-06-12 20:29:03 +01:00
OpenStack Proposal Bot b730fb4889 Updated from global requirements
Change-Id: I740887e92dc4bb043df7ec4be4565be2259cb5de
2018-03-15 07:32:27 +00:00
OpenStack Proposal Bot 6f43b03bcd Updated from global requirements
Change-Id: I6334947166ebc3c7452d57f96f142fe918c6e204
2018-03-10 13:34:25 +00:00
ZhongShengping 273b9307f6 Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

For more detials information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I496f18d1504033859ded9e9a9606c063a174eff9
2018-03-09 12:01:26 +08:00
Jean-Philippe Evrard 51c3b98e96 Remove pip_install dependency
With addition of pip_install on every node, we don't
need to have pip_install as a meta dependency.

Depends-On: If3412bb888ebb854874bbc43eb76bfcb3e4a7868
Depends-On: I79ff70c438b44753be2a93f004ebbc46de0a963d
Change-Id: Ida4ab55cde5b220d62a5b2ae4a503bffd1f82497
2018-02-07 19:35:37 +00:00
Jean-Philippe Evrard bcc6ea58dc Initial OSA zuul v3 role jobs
This patch implements an initial set of jobs intended to match
the current job execution method. It does not intend to improve
how the jobs are executed - only to replicate what is currently
in openstack-infra/openstack-zuul-jobs and provide the platform
to iterate on.

Change-Id: Ie76b4452e58b3da82c8119b9bdb3bbb274e17137
2017-10-20 09:23:24 +00:00
ZhongShengping ae74a73f98 Update URLs in documents according to document migration
Change-Id: Ia6567e81e9c854181cd1d1bac4cb0927c0243127
2017-07-17 10:31:06 +00:00
ZhongShengping a5c5c4f145 Fix openstackdocstheme settings
To use openstackdocstheme 1.11.0 properly, this patch fixes
some settings according to follow[0].

[0]https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: I24d8749c87fa86b4edd6893baf0be1d3581c0e0e
2017-07-03 16:13:04 +08:00
Miguel Alex Cantu 5e6ff1ea5f Remove Ceilometer API Service
Ceilometer API is now deprecated in favor of using
Gnocchi, Aodh, and Panko to pull telemetry information.

Change-Id: I4464fc6bd4ad3ef14e2638abcdb86180e82615e1
Closes-Bug: 1666640
2017-03-02 15:42:08 +00:00
Jenkins c1aeb3728b Merge "Deprecate ceilometer-collector" 2017-02-22 19:19:41 +00:00
Miguel Alex Cantu 8784e73eec Deprecate ceilometer-collector
Per https://review.openstack.org/#/c/413920/, the ceilometer-collector
service is now deprecated.
This commit removes the inventory group mappings to the
ceilometer-collector service/container. It also removes
the service from the bootstrap and testing inventory.
Gnocchi is now explicity used as a publisher in the
pipeline.

Partial-Bug: 1666238
Change-Id: I396b154d106c0afba44d57792ae6dad39b33a6f5
2017-02-22 10:42:06 -05:00
alextricity25 6434b5950f [DOC] Remove confusing sentence
The paragraph has been trimmed down to improve clarity on when
the ceilometer playbook should be run.

Change-Id: I1bcfa3955fc29f5f1cc607f440d30c7cd343ffa2
Closes-Bug: #1631029
2017-02-21 18:24:59 -05:00
Cao Xuan Hoang faf5792b51 Use https instead of http for git.openstack.org
Trivialfix

Change-Id: Ic19a9323606f690b7ec4bf7b26bbd23e8263619a
2017-02-06 16:48:10 +07:00
Andy McCrae afdd9a6648 Update repository with reference to role git location
Change-Id: Id030e22d6c8b88a217a0aabf8f1d7a119773758c
2016-12-22 14:26:21 +00:00
Jean-Philippe Evrard ebc92fb891 Point roles docs bugs to openstack-ansible LP
Currently when clicking on the small bug in the roles'
docs, we land on openstack-manuals launchpad.

This should solve it.

Change-Id: I8e8e505534312adc50ada7b65a46fe8b63ad2dfe
2016-12-01 14:58:53 +00:00
Joshua Hesketh 35a976761a Replace github with git.o.o
Change-Id: I86a3a1cab7ca25126f41f8271780dee2dabf5dd1
2016-11-02 12:18:11 +11:00
Nish Patwa 2dd0b612ef [DOCS] Added release-name as a watermark to Docs.
Added a water mark to the role documentation
to make clear to deployers which release they're
working with.

Modified conf.py that adds watermark to the documentation according
to particular branch. If the current branch is master than
watermark is 'Pre-release' and if the current branch is
stable/<release-name> than watermark is <release-name>.

This is a combined implementation based on the following
patches:
- https://review.openstack.org/372565
- https://review.openstack.org/382637
- https://review.openstack.org/384140

Change-Id: I1bcbb80d0540faca79a3c46f4bcae2e63ebea3ca
2016-10-20 17:48:31 +00:00
Travis Truman 8a524c3d62 Add storage details to role docs
Call out the default storage configuration and how it can
be overridden by deployers.

Change-Id: I5009dacae86e9837ec8794dca785c33baee0b6f8
2016-10-03 16:09:22 -04:00
Travis Truman 5714ad87d0 [DOCS] - Remove overview from TOC
The overview.rst has been removed and should not
be present in the TOC

Change-Id: I3b75658614be0d7a16b24272b8ce62197dccf1a7
2016-08-17 10:37:45 -04:00
alextricity25 6d7679d077 [DOCS] Move ceilometer configs from developer docs
This commit moves the ceilometer configs in the developer docs
over to the role. It also cleans up README.rst and index.rst to
support the new tree structure for role docs.

As a note, some of the role docs(like this one), do a literalinclude
on files in the integrated repo. These references need to be fixed
to reference the link since the included file will no longer exist
in a guaranteed location that can be referenced with relative paths.

Change-Id: Icfaa49c1876b633adf6b61881006c676b1a57cdc
Signed-off-by: alextricity25 <miguel.cantu@rackspace.com>
2016-08-12 13:33:10 -05:00
Jesse Pretorius 1a46237902 Ensure that doc linting is included in the linters test
The 'docs' tox target executes the doc8 lint test which may result in
failures when testing documentation builds, but OpenStack-CI does not
execute that tox target.

In order to ensure that we catch all standard documentation syntax
errors and prevent them from merging, this patch includes the docs
target in the 'linters' chain of tests.

Fixes for any failures which result from executing this test are also
included in the patch.

Change-Id: Iac3ca83a89de06490b7b6d3cd414825f5c2eb1ce
2016-07-26 00:37:15 +01:00
Jesse Pretorius 5b0dfd8f82 Update sphinx configuration
This patch updates the sphinx configuration for docs and releasenotes
to make it easier to replicate across repositories and to comply with
pep8 testing without exceptions.

Change-Id: I5da98b51b71c0e7869944139b595617fdf692081
2016-07-12 16:52:04 +01:00
Travis Truman 091850c7bc Clarify role documentation and remove duplication
The README now makes clear that MongoDB is a dependency
and the role doc itself now simply includes the README
instead of duplicating its content.

Change-Id: I0cfea0bccf27787243aba2e046cb2f5327a158ef
2016-04-18 10:42:49 -04:00
Steve Lewis e704560e49 Remove unused galera_client and related vars
This is related to the effort of adding functional testing to this role.

Change-Id: Iae3aba06d4f0ebced8879c392ba49955834a874b
2016-03-09 10:56:22 -08:00
Jimmy McCrory e090a5523e Implement base configuration for independent repository
Change-Id: I66751a4255a0d37ce97f7ebaf15db57dbfa1d2c5
2016-03-01 09:43:48 -08:00