Commit Graph

27 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
Petr Kovar 62c1fd4b03 Add Front page template for project team documentation spec
Change-Id: Ic665d4ece58b2ab00f2bbe6ee8d21039382a9e4d
2018-07-20 16:33:52 +02: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
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
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 f1ba42f0fb Merge "Remove unused modules" 2017-04-18 12:41:30 +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
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
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
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
Linette 1fa74a1898 [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
2016-04-05 14:55:03 -05:00
Harshada Mangesh Kakad 9ab854b2a1 Replace deprecated library function os.popen() with subprocess
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.

Change-Id: I2dd8cc9165da767add0b0186ea36864b1cb28fcb
Closes-Bug: #1529836
2016-01-14 06:11:26 -08:00
daz a4a18c9a50 Convert Architecture Design Guide to RST
Specification to convert the Architecture Design Guide from DocBook to RST

Change-Id: I14a6d9efdb657f337a0f5e42d33321f460cc5eb6
2015-08-24 12:23:44 +10:00
sayalilunkad 9a34fd1afb Spec: Audio Visual Training Videos
This spec provides description and required
deatils about delivering videos for audio
visual project.

Change-Id: Iab894057fe2a1e0cfb123d437d794947c9bea588
2015-05-03 07:27:54 +02:00
Andreas Jaeger 70de575448 Improve titles
The specs that show up on the web page are approved, let's word these.
Also mention Kilo first since it's the release we're working on
and use headings.

Change-Id: I3437a951cd46d3bd032455092bffe4d4e7536725
2015-01-16 13:53:36 +01:00
Anne Gentle 36465bdb0c Adds detailed specification for migrating to new web design
- Also includes minor typo fix in template.rst file.

Change-Id: I0c1f63bef3ace46c76ddf2b61014c95f40422064
2015-01-07 10:37:51 -06:00
Jenkins bbaeb5e1fd Merge "Use the current date for the copyright statement" 2014-09-21 10:33:50 +00:00
Jenkins 59b599e273 Merge "Remove templates from toctrees" 2014-09-21 10:32:14 +00:00
Jenkins 88200d5b7d Merge "Add RSS feed" 2014-09-21 10:29:28 +00:00
Andreas Jaeger 12a884ad63 Stop using intersphinx
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This causes docs jobs to fail because we error out on warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
2014-09-12 22:50:36 +02:00
Doug Hellmann 6f676615af Use the current date for the copyright statement
Change-Id: Ib23fbdb57cd13cee32ed1f03f8f1393ac8e43fe7
2014-09-10 15:59:03 -04:00
Doug Hellmann 10c055480f Remove templates from toctrees
We don't want the templates to show up in the RSS feed, so exclude them
from being converted to HTML and listed in the toctree.

Change-Id: Idcb658b5557bdc8867d6c550d7ec5fce3a596421
2014-09-10 15:59:03 -04:00
Doug Hellmann 72c2a92d4b Add RSS feed
Publish an RSS feed of the changes to the specs repository to make the
specs more discoverable.

Change-Id: Ib4f84efab8b3af3ddd47d38d63a91362612bd655
2014-09-10 15:59:01 -04:00
Andreas Jaeger c2562490b5 Improve docs-specs setup
Now that we have a first template, remove the example spec that was only
added so that we had one specification and thus could gate.

Improve the index page to include the README and reference both
sample template and empty skeleton.

Enhance README to include URLs about this repo and where it gets
published, also make URLs clickable - and not verbatim text.

Change-Id: I1627db3cfd6bdd44e1dd35ad1c18ec8db633056e
2014-08-02 20:06:40 +02:00
Andreas Jaeger 14fe5bc1b3 Rename Contents to Template
The first entry is just the template, not the contents, rename it.

This also serves to check that publishing works properly.

Change-Id: Ia857ebddc71cb4b0119e6d2df76bbfd095141af4
2014-07-30 19:36:17 +02:00
Andreas Jaeger c5cde27874 Setup docs-specs gating
Add all needed files so that the gate passes.

The setup has been copied from nova-specs and adjusted.

Change-Id: I3d7276392cf84102b2c3e7c4c28fe696aa147f4f
2014-07-04 09:28:22 +02:00