Commit Graph

38 Commits (master)

Author SHA1 Message Date
Ghanshyam Mann 6fb715b47c [community goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].


Story: #2007236
Task: #38556
Change-Id: I4bfe9db179fdf2285e847544cdb98c597ec388a6
2021-05-17 19:28:10 -05:00
Andreas Jaeger 9238dbe1c0 Update to openstackdocstheme
oslosphinx is dead, convert to openstackdocstheme and update for

Change-Id: I4e5abc8485103f5b830759056db24185670c5ec2
2020-06-09 07:04:43 +00:00
Sean McGinnis ae6b370636 Fix gitreview host name
This can cause issues with release automation when the repo is tagged
since the host will not match what is expected for the ssh key.

Change-Id: Ia6df4fa3aacb4f29f02cc24f7a3a0fdcbd92a0a1
Signed-off-by: Sean McGinnis <>
2020-02-18 11:03:21 -06:00
OpenDev Sysadmins 6647dfc02c 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:

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 with any
questions you may have.
2019-04-19 19:33:16 +00:00
Zuul 296d6bc761 Merge "make tox docs environment follow PTI guidelines for sphinx build" 2019-01-10 17:51:20 +00:00
Jeremy Stanley fb984e8cbe Update contact address to openstack-discuss ML
The openstack-dev mailing list has been retired and its
conversations now take place on openstack-discuss instead.

Update this cookiecutter so that new projects don't copy over the
obsolete ML name.

Change-Id: If51603dd42656002408bd90cfb319b5d99c2d0e5
2018-11-30 19:08:49 +00:00
Adam Spiers fe1271a182 make tox docs environment follow PTI guidelines for sphinx build


    We strongly discourage project teams from adding commands to the
    docs environment beyond:

        sphinx-build -W -b html doc/source doc/build/html

Discussion on #openstack-doc prompted the suggestion to adjust the
cookiecutter templates accordingly:

Also update requirements.txt.

Change-Id: Ib3733daffb724fa13267aec6ac4f14cb91bcd5ba
2018-08-09 18:56:35 +01:00
Ben Swartzlander 5be6883fc1 Fix spelling error in template.rst
project_name was misspelled projcet_name, which
caused failures when following the instructions
to create a new repo.

Change-Id: Ie12429386b9a41caf3c145d7229ea37acd57f64b
2016-05-02 14:25:44 -04:00
Jenkins 0d18697f70 Merge "Cleanup .gitignore" 2015-07-31 19:33:07 +00:00
Jenkins 0c5eb31570 Merge "Update requirements" 2015-07-31 19:32:57 +00:00
Jenkins d565d80858 Merge "Remove .coveragerc" 2015-07-31 19:32:49 +00:00
Jenkins 506e571a8c Merge "Replace ci.o.o links with docs.o.o/infra" 2015-07-06 19:41:56 +00:00
Andreas Jaeger 630cf29e50 Cleanup .gitignore
This is not a code repository but a spec repository. Remove entries that
are not part of a normal spec repo.

Change-Id: I0662cf6edcfbcf984a92071a36ec5899eef40d83
2015-07-06 21:23:30 +02:00
Andreas Jaeger 734c4af494 Update requirements
Sync manually with global requirements file, don't limit to pbr 1.0.

Change-Id: I30c836410771a91070739018a0cad8d4b62b3412
2015-07-06 21:21:58 +02:00
Andreas Jaeger 6b4f6fec79 Remove .coveragerc
specs-repos don't run coverage, remove the unused file.

Change-Id: I2cd5fb0e7376e1fe4d444c0a09a8f7f9e4ddb923
2015-07-06 21:20:54 +02:00
Jeremy Stanley 6e143e1aeb Improve CONTRIBUTING.rst for clarity
Change-Id: Iff43a884089ce2bc32cd9e1cbc5d94dd44a03b8c
2015-05-16 13:18:50 +00:00
Jeremy Stanley 0e7ad88746 Replace ci.o.o links with docs.o.o/infra
The documentation site has been deprecated,
replaced by redirects to corresponding paths within where other Project Infrastructure
documentation already resides.

Change-Id: Ia8e35ad1b0d8aaeeaea3c9eac6cb797e14cae9f2
2015-05-14 21:38:16 +00:00
Marc Koderer b875d5dc67 Fix example template
The existing template does have some syntax error and
can be transformed to html.


Change-Id: Icc8ea8d10d3f15637d47fefb69c1a9234564dcf4
2015-03-12 15:11:41 +01:00
Marc Koderer c9d9669408 Fix issue with doc build
Sphinx doc build has issues if the path to a resource is relative.
This adds a symbolic link instead of a relative path. See [1] for more


Change-Id: I76ef25fbc3876408a422d826974510a978fcb686
2015-02-20 11:18:02 +01:00
Jenkins 7ec7def233 Merge "Add RSS feed" 2014-12-10 13:42:53 +00:00
Jeremy Stanley c3d0b3f37e Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: I126eb57446ca3655e8f7da18a19c16240c4efae4
2014-12-05 03:30:42 +00:00
Doug Hellmann d8f004af75 Add RSS feed
Publish an RSS feed of the changes to the specs repository to make the
specs more discoverable.

Do not include the template in the toctree so it will not be included in
the RSS feed.

Use the doc build date to produce the copyright string instead of using
a hard-coded value.

Change-Id: Ib4f84efab8b3af3ddd47d38d63a91362612bd655
2014-09-10 16:05:00 -04:00
Andreas Jaeger 05c49b56f5 Remove docutils pin
This was added to work around bug 1091333.  A new sphinx has been
released and so this is no longer necessary.

Change-Id: I9107884d964757a9154bdd1feb4ea6df4e9df43e
2014-09-10 21:53:53 +02:00
Jenkins 958106f0de Merge "Update readme to refer to specs-cookiecutter" 2014-05-20 15:19:55 +00:00
Matthew Treinish 59ef111172 Update readme to refer to specs-cookiecutter
This commit updates the readme to actually refer to itself instead of the
openstack cookiecutter that it was copied from.

Change-Id: Ia33311bc8b0c88177c6661fad98fa62182738fbd
2014-04-25 15:19:48 -04:00
Doug Hellmann 78397ebea2 Add optional spell checker target
Add a tox target using sphinxcontrib-spelling to let
authors run a spell checker against documents before
submitting them.

Change-Id: If519fb63bc4b0923a48df9e0435125fd66ab5c0c
2014-04-16 12:41:10 -07:00
Doug Hellmann 2cb8d8b486 add .gitreview file
Change-Id: I4a81632fe58bfca027d2a7baa74d51304ca67ee8
2014-04-16 12:41:02 -07:00
Matthew Treinish 6385206bfa Allow running tox without any arguments
This commit adds an envlist to the tox.ini to enable running tox
without any arguments. This is based on nova-specs change:
2014-03-31 14:18:14 -04:00
Matthew Treinish 83ed9ad804 Drop site packages and rename build_specs to docs
This commit drops site-packages from the tox.ini because it isn't
needed. It also renames the build_specs tox job to docs to be
consistent with the other projects.

Based on nova-specs changes:
2014-03-31 14:17:14 -04:00
Matthew Treinish a3e0a464f0 Make sphinxbuild fail on formatting errors
This change will cause docs build to fail if rst is badly formatted.

Based on nova-specs change: I20e31fb25717388c22c54d5109afc4a56f9ab28d
2014-03-31 14:12:18 -04:00
Matthew Treinish b0c9859844 Make sphinx compileable
Actually testing things is probably pretty important
2014-03-26 15:30:09 -04:00
Matthew Treinish f421e329a4 Fix cookiecutter json again
Make the json file actually readable by cookiecutter.
2014-03-26 15:19:14 -04:00
Matthew Treinish f4274ea441 Add missing comma to json file 2014-03-26 15:13:19 -04:00
Matthew Treinish 263e1d704a Add a template spec
This commit adds a basic template based on the one in the qa-specs
repo. It obviously won't be exact for every project but it gives a
starting point.
2014-03-26 15:05:59 -04:00
Matthew Treinish f450937508 Add new project_name variable to cookiecutter
This commit adds a new cookiecutter variable to specify the targeted
lp project that specs in the added repo are targetted against. For
example if the repo_name was nova-specs project_name would be nova
or for qa-specs it would be tempest.
2014-03-26 15:00:27 -04:00
Matthew Treinish 111da2a1d8 Update index to make it more legible
This commit changes the organization of the index to make it clear
what is documentation and what is a spec file.
2014-03-26 14:54:31 -04:00
Matthew Treinish 8738f58981 Switch license to CC
This changes the specs repo default license to be CC instead of apache.
2014-03-26 14:36:49 -04:00
Matthew Treinish bfd23b3fbb Add basic cookiecutter template 2014-03-24 14:46:13 -04:00