Commit Graph

201 Commits

Author SHA1 Message Date
Stephen Finucane 5a82d7e9a2 Retire docs-specs
We haven't used this in a long time and with the transition of docs from
a project to a SIG, it's not likely to be used again going forward.

Leave the .zuul.yaml file with noop-jobs to allow this patch to merge.

Change-Id: I557bace8008cc3b4fc1f78264f93291c49f897ad
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Depends-On: Ie3ed990df99057896130ed0f7d5cf6c07db8c962
2019-07-03 10:54:39 +01:00
OpenDev Sysadmins 81abe0dfe2 OpenDev Migration Patch
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:34:53 +00:00
98k 58980b4d8f Change openstack-dev to openstack-discuss
Mailinglists have been updated. Openstack-discuss replaces openstack-dev.

Change-Id: I5091ab913c9bb1b2106d176ef3461a7a221e29ff
2018-12-06 07:37:49 +00:00
Andreas Jaeger 6efa693f2a Fix sphinx invocation
We use now "tox -e docs" and the sphinx-build invocation was using the
wrong directory - fix it.

Also, add doctrees option.

Change-Id: I527a08565cdc876dc862f1a944de06eddb7c33c9
2018-12-06 08:36:43 +01:00
jacky06 37fd4b3a18 Update links in README
Change the outdated links to the latest links in README.

Change-Id: Ic8d1b4b7ef8c52f593a805a79d86150dffef6f7c
2018-08-24 01:25:23 -04:00
Zuul b324400ae3 Merge "Add a missing blank line before a subitem" 2018-08-15 13:45:58 +00:00
Doug Hellmann e6de5e7a88 use python3 in tox
Set basepython once in testenv and let the other environments inherit
the value.

Change-Id: I98aa7d500d2c3abe3f10b09b282ea550bec5f43c
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-08-14 13:11:10 -04:00
Doug Hellmann c62cda75e5 import zuul job settings from project-config
This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project
repository.

Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.

Because this patch is generated by a script, there may be some
cosmetic changes to the layout of the YAML file(s) as the contents are
normalized.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: I0a41a563276118d84c53078110593c54982c64b3
Story: #2002586
Task: #24293
2018-08-13 16:45:55 -04:00
François Magimel a1b16987ae Add a missing blank line before a subitem
Change-Id: I6268ea73eba992db0022587dd651fd1c6e49f830
2018-08-13 21:51:30 +02:00
Zuul 22268fd917 Merge "Add Front page template for project team documentation spec" 2018-08-03 08:50:39 +00:00
jacky06 c2dfc67b65 Update the link to https
Change-Id: Ie479cd2c97cc0c18ca4440df565ee05ebdca4112
2018-07-21 02:34:08 -04:00
Petr Kovar 62c1fd4b03 Add Front page template for project team documentation spec
Change-Id: Ic665d4ece58b2ab00f2bbe6ee8d21039382a9e4d
2018-07-20 16:33:52 +02:00
Nguyen Hung Phuong 154df6365c fix tox python3 overrides
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.

We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.

We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.

Change-Id: I7b65a9dbb394224550008f0feeb5a47bb743c208
2018-07-03 10:26:26 +07:00
Nguyen Van Trung 1e04477632 Drop py34 target in tox.ini
We support py35 now.so it is no need to keep
the supoort for py34.

Change-Id: Ida64148f34ea5ec7191c6a8320587d9a0fe2e30a
2018-01-29 10:12:55 +07:00
Petr Kovar b20ddbf06e Add trivial change
This is to trigger refresh of
http://specs.openstack.org/openstack/docs-specs/ which is missing
index for Queens specs.

Change-Id: Ic7a167abc1bc19e53edd02a3bbdced39a6d9c129
2017-10-23 19:09:35 +02:00
Zuul 8146272d0e Merge "update the retention policy for queens" 2017-10-17 17:15:13 +00:00
Doug Hellmann 22bee2f597 update the retention policy for queens
Replace the old archiving spec, which was never implemented, with a
new one for queens describing the updated retention policy.

Change-Id: I6e6fa98c577aa0d95af0824b763ce6a3b4728cbe
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-10-10 13:51:06 -04:00
liangcui ea29aa4b71 modify some misspellings
Change-Id: I5ae626be2a2db6b56dd73328748e7d13006f6961
2017-08-22 14:51:18 +08:00
Doug Hellmann 1f6bd25257 switch to openstackdocstheme
Change-Id: I1f5ddac09dac298fd5863d778a1b948d0bd48660
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-25 16:40:44 -04:00
Alexandra Settle c6f1e88a6b Add glossary decision to doc-migration spec
Change-Id: Ic36a36b35dbacc8ef17798bb0868d7cd9159ff2b
2017-06-27 14:55:21 +00:00
Doug Hellmann 3a999928ed add a point about subdirectory index.rst files
Change-Id: Id0fd0d395ac4d1956880eb2e7fa7f28bffcd57b5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-23 11:56:20 -04:00
Doug Hellmann eb74e55226 a few clarifications to the doc migration spec
Some of the steps in the openstack-manuals repo are now being handled by
the templatization work, and don't need to be done by project teams as
they migrate their content.

Change-Id: I304b2dd6e8bb220425298cd5d442cc31e49cb699
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-23 10:12:59 -04:00
Alexandra Settle f0fe465f69 Adds spec for migrating the documentation suite to project repos
Currently the user-facing documentation belongs in the
openstack-manuals repo. Due to a severe decline in contributions,
the docs team has had to come up with a new way to move forward.

This spec proposes the new process for user-facing documentation
and how we are going to undertake the changes.

Co-Authored By: Doug Hellmann <doug@doughellmann.com>
Co-Authored By: Alexandra Settle <a.settle@outlook.com>
Change-Id: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
2017-06-21 15:48:06 -04:00
melissaml 912ed2fd2f Fix html_last_updated_fmt for Python3
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: I4c14b2d1f5143171bb7a09fda1c09c0d576d1aa0
Closes-Bug:#1693670
2017-06-16 04:31:15 +08:00
Jenkins 98180a2251 Merge "Adds spec for unifying the themes used on docs.openstack.org" 2017-04-20 22:10:05 +00:00
Jenkins c267b40ed5 Merge "Add spec for updating and publishing tools documentation" 2017-04-20 22:01:13 +00:00
Anne Gentle 44f2f0db33 Adds spec for unifying the themes used on docs.openstack.org
Currently both oslosphinx and openstackdocstheme are in use
for content built to docs.openstack.org. To offer a better
user experience, update the logo, and consolidate efforts,
use one theme going forward.

Change-Id: Ib946c9215d85e472a55fd13ec246656614247019
2017-04-20 21:55:40 +00:00
Jenkins 38375683e1 Merge "Allow building with python3" 2017-04-18 12:46:51 +00:00
Jenkins f1ba42f0fb Merge "Remove unused modules" 2017-04-18 12:41:30 +00:00
Andreas Jaeger 1319f331d3 Allow building with python3
yasfb 0.6.0 has been released and works with python2 and python3, so we
can remove the basepython setting from tox.ini.

Require at least version 0.6.1 since that fixes a unicode bug.

Change-Id: Ia52a874a58b693d090e6921e4a3a2ff49345d8ba
2017-04-14 20:11:41 +02:00
johnsom 4d20a0afd4 Move administrator guide to project repos
The number of approved OpenStack projects continues to grow while the
documentation team resources are shrinking. We need a new approach to maintain
the high quality of the OpenStack documentation set.

This specification proposes allowing project teams to manage their
administrator guide content similar to how the api-ref and installation guides
are being managed.

Change-Id: I70592f5c8a415dc1454a89f1012ad50178359953
2017-04-11 12:46:56 +00:00
Monty Taylor ec388af66b Fix sphinx warnings
Ensure pbr 2.0, which includes a number of bugfixes along with support
for Sphinx 1.5's 'warning-is-error' option is used. Then suppress
"WARNING: nonlocal image URI found" - which gets triggered by our
inclusion of badges in the README.

Change-Id: I1901ec7d19f4d13ef6c8b814243786fb23e70b78
Co-Authored-By: Stephen Finucane <sfinucan@redhat.com>
2017-04-11 13:39:13 +01:00
Andreas Jaeger 4216b26435 Remove unused modules
Remove unused Sphinx modules.

Change-Id: Id63ff145835bbea54e7208fc2c31d5b594721b92
2017-04-11 12:07:23 +02:00
Brian Moss e4a7942e03 Add spec for updating and publishing tools documentation
Update and complete the documentation for openstack-doc-tools
and openstackdocstheme, and publish guides to
docs.openstack.org/developer.

Change-Id: I8437d28079a4da544cf6085704cccff7a7587f23
2017-04-11 10:58:21 +10:00
Jenkins 661dd09963 Merge "Revise the Architecture Design Guide for Pike" 2017-03-03 12:01:27 +00:00
daz 77b3608e23 Revise the Architecture Design Guide for Pike
Spec to continue work on revising the Architecture
Design Guide which includes our goals for Pike

Change-Id: I4cbfcca07f614820da2efc0e9f2f106b94dc805e
2017-03-03 14:26:23 +11:00
Andreas Jaeger 858de30916 Enable sphinx warnings
With pbr 2.0 and Sphinx 1.5, we need to use warning-is-error for sphinx
warnings.

Disable the non-local-uri warning, it's raised by our badge in
README.rst.

Change-Id: I77ff11a3cd0742bc4c1a6e7037644801877f6661
2017-03-02 17:01:20 +01:00
Andreas Jaeger 038542ceed Update requirements
Sync with global requirements to use newer tools.

Remove docutils, we don't need the blacklisting of version 0.13.1
anymore.

Change-Id: I54786a6000427fda6ac93a6c254e2f646629ad20
2017-03-02 14:33:32 +01:00
Lana Brindley 4ce480f4e2 Adding Archiving spec
Based on email thread and meeting conversation, adding a spec to
address the requirement to archive old content, and make it available
to users on older versions of OpenStack. Also adds Pike to specs index.

Change-Id: I7dffceddb040137b0f1448ba4baebcb5c5dfc9d9
blueprint: archiving
2017-02-13 05:33:52 +00:00
Alexandra Settle e2abbcd68b [ha-guide] Proposal to improve the HA guide for Ocata/Pike
Change-Id: I41c52816aba1eb8f65c289fa30a7ded904a9bb84
2016-12-26 03:25:08 +00:00
KATO Tomoyuki 398874c021 Skip docutils 0.13.1
The 0.13.1 release breaks some documentation jobs
when it tries to build docs with remote images.
This has been reported upstream[0]. The version
matches the supported docutils versions for sphinx.

[0] https://sourceforge.net/p/docutils/bugs/301/

Change-Id: I7fb8c0fa9518b6b16eba6f7c5607c94136ebca53
2016-12-26 11:56:32 +09:00
Jenkins 55415f1c27 Merge "Update content to using Latex from rst2pdf" 2016-12-01 21:10:25 +00:00
Jenkins d71f862dcb Merge "Changed the home-page link for docs-specs" 2016-11-29 01:53:04 +00:00
Jenkins 32768aec12 Merge "Show team and repo badges on README" 2016-11-29 01:49:33 +00:00
Jenkins 5cc6dbed59 Merge "[arch-design] Revise the Architecture Design Guide" 2016-11-28 22:10:05 +00:00
Jenkins 46c5e6d17c Merge "[ops-guide] Link to project upgrade notes" 2016-11-28 22:09:59 +00:00
SeongSoo Cho ec23c2fae7 Update content to using Latex from rst2pdf
The Sphinx 1.3 is not compatible with rst2pdf.
The another solution is using LaTeX to generate pdf files

So, update the content to generate pdf using LaTeX from
sphinx + rst2pdf

Change-Id: I773def424637157ae03e6ada51a905880c0e3bf1
Implements: blueprint build-pdf-from-rst-guides
2016-11-28 22:38:27 +09:00
Flavio Percoco 7267b873b1 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/1e25637b9d349b16b5c452abf36dcffe\n'

Change-Id: Ie5f44fc84cff60a85405c3b88fc9d072b854d2e0
2016-11-25 14:44:37 +01:00
daz 9f6cf2f193 [ops-guide] Link to project upgrade notes
Add links to keystone, nova, neutron, swift, and glance upgrade notes
in the Operations Guide

Change-Id: Ia09b6d6df15f25590e8205af876da960e72758ed
Implements: blueprint ops-guide-upgrades
2016-11-24 21:34:58 +00:00
daz b4d88f32ca [arch-design] Revise the Architecture Design Guide
Spec to continue work on the Architecture Design Guide
for Ocata

Implements: blueprint arch-guide-restructure-ocata
Change-Id: I411045798e4d3d056669a563af058d6217b7b6b2
2016-11-21 01:32:56 +00:00