Commit Graph

23 Commits

Author SHA1 Message Date
Dmitriy Rabotyagov e29db7b3cb [doc] Document how to use "local" memcached
Having "local" memcached might be valuable for some usecases,
like availability zones, where distance or connection between
controllers is a concern, and memcached with lowest latency should
be preffered whenever possible.

Change-Id: Ie285e582fc9ada149c199a3bd4e6344035068bd3
2023-07-11 20:07:21 +00:00
Dmitriy Rabotyagov 9847bf2f59 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: I40b2635eafe8221218010d1c3cd5cf5717bc2800
2022-05-30 16:01:15 +02:00
Dmitriy Rabotyagov cb2c377a4f [doc] Fix haproxy_extra_services layout
Change-Id: I417ba36c54ffd62a6eea57a2d7ef04b422585a3c
2021-10-19 12:24:41 +00:00
Jonathan Rosser 2bb11b1b1b Fix linter errors
Change-Id: I24b4749dba7ce48fbbd0bd5df51269b141375bc5
2020-10-02 07:32:15 +01:00
Andreas Jaeger d496dad42d 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: Iaf5e1a33e4ce165fd31e8fd6aebee577b1cffb13
2020-06-03 19:02:52 +02:00
Andreas Jaeger 02e08a49c3 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: I300d3d1a2e4fb16805484fc7c30d61c041b6b7f3
2020-05-20 18:45:31 +02:00
melissaml 7fc569c154 Cleanup py27 support
This repo is now testing only with Python
3, so let's make a few cleanups:
- remove setup.* files, we don't need them for this repo
- Cleanup */source/conf.py to remove now
  obsolete content.
- Remove install_cmd, the default is fine,
  move constraints into deps.
  Cleanup tox.ini a bit

Change-Id: I00d81ef2ce142faadc4064e3fe15ca020783a7b4
2020-04-27 19:43:30 +02:00
Dmitriy Rabotyagov 5f7f49f8b3 [doc] Fix playbook path
Change-Id: I953d8e7b9b36db5dbb8fd1cf8cf73714f12a246e
2020-01-23 23:31:14 +02:00
Dmitriy Rabotyagov 047c5c86ec Document access memcached via haproxy
Failure of single memcached instance now causes some delays in API
responses even with usage of oslo_cache.memcache_pool
Setting haproxy in front of memcache gives more reliable failover and
minimize delays in case of memcached failure.

Change-Id: Iea4fb513fe8a46fe7d9c04ce90d0fbf0d156cc4f
2019-12-26 15:23:30 +02:00
Dmitriy Rabotyagov 88bc0fade7 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: I0ea6477cb62773a1c9c82e77204c9bc72255a892
Story: 2006105
2019-10-17 15:37:24 +00:00
liuwei 4c9152cf73 update git.openstack.org to opendev
Change-Id: I26f9ce0de55a719df7c1330c01f48aa36056eb1a
2019-09-27 01:08:27 +00:00
Mohammed Naser 0b94c88e47 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: Ib13b99821aef29a78a4d83fd94991379bf9d4294
2019-04-06 02:22:31 +00:00
zhang.lei e49f7089cb Remove the deprecated "giturl" option
From openstackdocstheme 1.18.0, valid Git URLs can be retrieved by
openstackdocstheme[1], we do not need giturl option anymore.

[1] https://review.openstack.org/532163

Change-Id: If4189b08a126f5ee8c513992487fccc08b8871dc
2018-01-15 02:25:49 +00:00
Jean-Philippe Evrard 89319fd345 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: Iaee6f1c1836ee85770fd46a215e65cf2b2d517fa
2017-10-17 18:21:07 +00:00
gecong1973 ffce210f9b Use https instead of http for git.openstack.org
TrivialFix

Change-Id: I7edc7077ba702418ec09805e897474784a4a9f5a
2017-02-06 11:34:36 +08:00
Andy McCrae f23ca6d534 Update repository with reference to role git location
Change-Id: I9fb0a4b8421cdd95b8da3607afac816362a193a3
2016-12-22 14:26:20 +00:00
Jean-Philippe Evrard 77d2bcaf2f 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: Ia6788162ca5cf09db374e221d0997e6adc91b15b
2016-12-01 15:07:19 +00:00
Andreas Jaeger cb8203ad03 [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: Ic3201a200c52d1790103c30350ccfa9b84c6b425
2016-10-18 16:23:40 +00:00
Robb Romans 23cfc19a4c [DOCS] Move example playbook to separate file
Change-Id: I70b520be283fd1dfc48708d6a00b0c3b556f0b78
2016-08-11 20:29:07 -05:00
Jesse Pretorius db40d5997b 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: I2794185c0fce4c5fb027cb63d20850c72c4a91a4
2016-07-25 21:45:27 +01:00
Jesse Pretorius 7abca60268 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: I428a78d781a35e43d53bbcdaeb94658b5e0c91a7
2016-07-09 12:12:32 +01:00
Travis Truman 08fa22cea7 DOC - Adopting the common role documentation pattern
As discussed during the Newton design summit, we
agreed to adopt the role documentation pattern laid
out in the os_keystone role

Change-Id: Ia942dc97c41984a83dedbde5e37d14b328340164
2016-06-10 09:58:41 -04:00
Kevin Carter b818df54e2
first commit
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
2015-12-09 09:24:22 -06:00