Commit Graph

143 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
François Magimel a1b16987ae Add a missing blank line before a subitem
Change-Id: I6268ea73eba992db0022587dd651fd1c6e49f830
2018-08-13 21:51:30 +02:00
Petr Kovar 62c1fd4b03 Add Front page template for project team documentation spec
Change-Id: Ic665d4ece58b2ab00f2bbe6ee8d21039382a9e4d
2018-07-20 16:33:52 +02: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
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
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 f1ba42f0fb Merge "Remove unused modules" 2017-04-18 12:41:30 +00: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
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
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
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
Jenkins 55415f1c27 Merge "Update content to using Latex from rst2pdf" 2016-12-01 21:10:25 +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
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
Pranav Salunke aee2779952 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
2016-11-19 16:05:20 +01:00
zhouyunfeng 4ef9b26500 Fix Spelling Mistake
Change-Id: I5fb39bdef8f8e160bec475d7dce4edecb70fdf6f
2016-11-15 10:58:23 +08:00
qiaomin a271c3567a 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
2016-10-26 13:49:27 +00:00
Jenkins 09c2303c0e Merge "Adds a spec to build PDFs as Ocata goal" 2016-09-23 05:37:52 +00:00
Jenkins 600d2eab4b Merge "Add Release chapter to Contributor Guide" 2016-09-12 02:17:30 +00:00
Jenkins 5214e5f7a1 Merge "[CG] Release notes guidelines" 2016-09-12 00:58:15 +00:00
Ian Y. Choi 4b24877092 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
2016-09-08 20:36:24 +09:00
Lana Brindley 18f22cc6f6 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
2016-09-06 09:25:30 +02:00
Jenkins bc320ccb37 Merge "Adds specification to improve glossary usage" 2016-08-30 23:49:51 +00:00
Jenkins d319a34b51 Merge "Adding a specification for consistency edits across the User Guides" 2016-08-22 23:08:06 +00:00
Emma Foley f7b0b11e0e Adds specification to improve glossary usage
Change-Id: I92dd6099c3ea866a6dd0728a5072d39505255080
2016-08-05 11:30:54 +00:00
OlgaGusarenko 673b97c4ac [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
2016-08-05 08:43:03 +00:00
Joseph Robinson 86401713a1 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
2016-08-03 17:34:23 +10:00
Jenkins 61be5b11f2 Merge "Correct the file path of .htaccess" 2016-08-02 22:40:46 +00:00
Akihiro Motoki c8de99f168 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
2016-08-02 13:37:29 +00:00
Anne Gentle ef694a834b Adds a task to update sitemap for hyphenated file names
Change-Id: I8ca296aa6febe17dc147b6f2d9aea145cda4b57e
2016-08-01 08:27:39 -05:00
Anne Gentle 22836a7979 Adds a specification to make RST file naming match hyphenation
Change-Id: I65274f89eec355fa7d5892208adc7d8e81f03ce2
2016-07-30 10:29:38 +00:00
Julen Larrucea 24044e920e [training-labs] Add PXE feature to training-labs
Change-Id: I5a48e96a7294a39e4528bae8a7e75eaa7a2a65e4
Signed-off-by: Julen Larrucea <julenl@gmail.com>
2016-06-28 07:51:13 +02:00
Jenkins 11c22f6882 Merge "Newton Install Guide" 2016-05-24 06:09:53 +00:00
Lana Brindley f1fc04faf4 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
2016-05-23 12:42:46 +10:00
Jenkins fd6bf2e28c Merge "Docs Contributor Guide Reorganization" 2016-05-18 00:49:36 +00:00
Jenkins 4c3a82901a Merge "Proposed architecture guide restructure" 2016-05-17 01:18:32 +00:00
KATO Tomoyuki fe70b117ba Docs Contributor Guide Reorganization
Change-Id: Ia364081a74ed53b0893e2af94df12941e9dda42d
Implements: blueprint contributor-guide-reorg
2016-05-16 07:24:26 +00:00