* Update docs-specs from branch 'master'
- 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
- 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.htmlhttp://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.
- Change openstack-dev to openstack-discuss
Mailinglists have been updated. Openstack-discuss replaces openstack-dev.
Change-Id: I5091ab913c9bb1b2106d176ef3461a7a221e29ff
- 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
- Update links in README
Change the outdated links to the latest links in README.
Change-Id: Ic8d1b4b7ef8c52f593a805a79d86150dffef6f7c
- Merge "Add a missing blank line before a subitem"
- 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>
- 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
- Add a missing blank line before a subitem
Change-Id: I6268ea73eba992db0022587dd651fd1c6e49f830
- Merge "Add Front page template for project team documentation spec"
- Update the link to https
Change-Id: Ie479cd2c97cc0c18ca4440df565ee05ebdca4112
- Add Front page template for project team documentation spec
Change-Id: Ic665d4ece58b2ab00f2bbe6ee8d21039382a9e4d
- 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
* Update docs-specs from branch 'master'
- Drop py34 target in tox.ini
We support py35 now.so it is no need to keep
the supoort for py34.
Change-Id: Ida64148f34ea5ec7191c6a8320587d9a0fe2e30a
* Update docs-specs from branch 'master'
- 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
* Update docs-specs from branch 'master'
- Merge "update the retention policy for queens"
- 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>
Project: openstack/docs-specs eb74e55226d4a27be864614c8915603999e5643a
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>
Project: openstack/docs-specs f0fe465f695ff7b4c1a246a07eae877746928e46
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
Project: openstack/docs-specs 912ed2fd2f9131abb74eb28a2b3512748d9df5e0
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
Project: openstack/docs-specs 98180a22512b07cd6d5594001475150a0d74b9da
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
Project: openstack/docs-specs c267b40ed54bafbd5dd97656e6bd2daf2b4f98e2
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
Project: openstack/docs-specs 38375683e1c819f809e93c42bea143d501d16795
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
Project: openstack/docs-specs 4d20a0afd4637bb637fde7922566d11b096dbfe6
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
Project: openstack/docs-specs 661dd099638a6f918e6ddae96fd4e94a39144895
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
Project: openstack/docs-specs 858de30916515cf3f6e9e6839171db533b064e4c
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
Project: openstack/docs-specs 038542ceedd1856e83394dce308c6eaa1fedfc0b
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
Project: openstack/docs-specs 4ce480f4e29d8514a8b01acbe8157d84ed731d04
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
Project: openstack/docs-specs e2abbcd68b6a37e6575ccc4f365f291c756b76e6
[ha-guide] Proposal to improve the HA guide for Ocata/Pike
Change-Id: I41c52816aba1eb8f65c289fa30a7ded904a9bb84
Project: openstack/docs-specs 398874c021c79b4e9a550e3e936e25fa3a7bbe02
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
Project: openstack/docs-specs 55415f1c2780b62719a2854149a0185bab2bb4d9
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
Project: openstack/docs-specs d71f862dcb37e07310f872447fdab7beeff3030f
Changed the home-page link for docs-specs
The homepage pointed to correct link in setup.cfg
Change-Id: I41c739d6f39270cdca2ef830f7c8806a3fd7e13b
Project: openstack/docs-specs 32768aec12aa5d94c81a108f30375983087a7374
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
Project: openstack/docs-specs 5cc6dbed597c84c591e0e2f84e514e3cc795e687
[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
Project: openstack/docs-specs 46c5e6d17c91b8e37b21a019075bf2be580b8868
[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
Project: openstack/docs-specs aee2779952632f8d38ec93d257cac427168d70ab
training-labs: Rewrite training-labs in python
Rewriting training labs in python for allowing better agility and growth
of the project. Allows the project to add new features like public cloud
support, better support for windows platform and more.
Change-Id: I1c1fef61a378eaaf6bad8a3179fc80658066a556
Project: openstack/docs-specs 490c2331502169fd2cb285aac27a5058b4709b17
Update requirements
Manual sync with global requirements to allow newer sphinx - the same
version we use everywhere else.
Change-Id: I385119e4f9dcd17bbe83aaef384e3f8593398870
Project: openstack/docs-specs a271c3567ac45724383865cb5435e76417f7b435
Use openstack command to replace other commands
Now the docs use different command-line client commands, in
order to promote the unity of the docs, there should use
openstack command to replace other commands.
Change-Id: I70426a2ee0bc97201371a9746b12cb2dd46b4475
Project: openstack/docs-specs 09c2303c0ec89b2193ca6000f00a339ddea14b34
Adds a spec to build PDFs as Ocata goal
New spec to propose to build PDF files from RST-sourced
guides in openstack-manuals repository for Ocata
Change-Id: I90a313a1912463774002e1afc712a94d4d32070c
Implements: blueprint build-pdf-from-rst-guides
Project: openstack/docs-specs 600d2eab4b6aaeb035950ef79df9208b09a908f2
Add Release chapter to Contributor Guide
Spec to add a new chapter to the Contributor Guide to cover
documentation release processes.
Change-Id: Ia2dec1d7649fd10e290586bbeaa60a33d70868cf
blueprint: release-chapter-contrib-guide
Project: openstack/docs-specs 5214e5f7a101dcfe8d8200906ae0af2228d833fb
[CG] Release notes guidelines
To maintain the overall quality of the OpenStack documentation,
the release notes guidelines should be developed and published.
Change-Id: I074870e5e3ae301e85385de49f0b2e201f8e9948
Project: openstack/docs-specs d319a34b517f6f9cd1fbf67781147169ef1e4076
Adding a specification for consistency edits across the User Guides
This spec bring together items remaining from Mitaka, and editing
points raised on the docs mailing list.
The goal is to edit the User Guides, and improve consistency
alongside some small Information Archiecture changes.
Change-Id: I515b570753c7eef26822374ff4df492bb27aed8d
Project: openstack/docs-specs 61be5b11f2a9e494a73a0bc372c950465b3a7915
Correct the file path of .htaccess
www/static/.htaccess is the correct filename.
This helps developers who work on the spec.
This commit also itemize assignee list and work items
for better readability in the rendered HTML.
Part of blueprint consistency-file-rename
Change-Id: I0b0a79c17bca61cf7f32d41d493e5354121dfd15
Project: openstack/docs-specs ef694a834bb9d6787bd4c51bb0e4b0d5db2f5740
Adds a task to update sitemap for hyphenated file names
Change-Id: I8ca296aa6febe17dc147b6f2d9aea145cda4b57e
Project: openstack/docs-specs 22836a79792247e64c9a93f36c3e3e77a47fad01
Adds a specification to make RST file naming match hyphenation
Change-Id: I65274f89eec355fa7d5892208adc7d8e81f03ce2
Project: openstack/docs-specs 11c22f6882e9c53433156f04de97848fb42599d9
Newton Install Guide
From Newton Design Summit working group. Update and
enhance existing Install Guide to better complement new
project-specific Install Guides.
Change-Id: Ide32c62d7a012ceee59d3fa19446ac3805a2f69e
Project: openstack/docs-specs 49cd59e3f1fb50bbd6aaf460ab52f56adaf73391
Removal of DocBook XML Support
Let's create a spec to raise visibility of these changes and mention all
steps that needs to be done.
Change-Id: I860e9f00367acc8735874e131b474f00ff35709f
Project: openstack/docs-specs 56c890fef1f6d26952b5bc63514439b23fd5e172
[docs-specs] UX personas spec
New spec to propose UX personas
in UI / UX section of the Contributor
Guide for Newton.
Change-Id: I1cb3c9084931f6400c560c2b16bd34afa9d9bbc1
Implements: blueprint ux-personas
Project: openstack/docs-specs caf24232a02a738572701724e3f0d173a1e35fd3
Project Specific Install Guides
This is a proposal that allows project teams to write their own Install
Guides and properly promote them. The goal is to have a situation that
does not cause significant load on the documentation team and gives main
responsibility to the project team. Instead the doc team should act as
enabler.
Change-Id: Ic028303dd42f055d284043ac5bec3854ef6769de
Project: openstack/docs-specs 5159528fc026bdd70c7a46f4c9c21ab72239f307
Add trove to install guide
The install guide currently does not
include trove.
This spec outlines a new proposed install guide
section that describes how to install trove.
Change-Id: I0dd02dba6ad8eeba0df172715b110c72743081b7
blueprint: installguide-add-trove
Project: openstack/docs-specs 1fa74a1898740f6701764f6c83e23c1b382d3428
[docs-specs] add newton and add new spec
In docs-specs, created new newton folder and
modified index to include and build newton.
Plus added one draft spec for working review.
Change-Id: I7cb0714582419e4e7189407bd423e1abc9bd562e
Implements: blueprint ui-heuristic-checklist
Project: openstack/docs-specs 02a2f78690d038f322324dbba388caabdfbb54a8
Convert warnings to errors for local builds
For local builds, call sphinx-build directly with -W
rather than assuming pbr works correctly.
Change-Id: Ic9ecddc7b54529dbf23900a3fde871de454b9b8d
Andreas Jaeger