13 Commits

Author SHA1 Message Date
ricolin
203bce9cd7 Switch to use opendev.org
Our cgit instance will be going away and opendev.org is the new
preferred URL for browsing our git repos. Redirects will exist for the
foreseeable future, but it's more efficient to just go directly to the
new locations.

Change-Id: Ic5fa1a8436f57836ad37b752a0cca1cd4f3a21a7
2019-04-22 09:36:50 +05:30
Dao Cong Tien
e8824a2c93 Adds doc8 check to pep8
This patch adds doc8 check for .rst files to pep8.
Files that fail doc8 check are also fixed.

Ignore D001 of doc8 check. This requires lot of changes and
should be done in a separated patch.

Change-Id: I7732abc55ec27026efbf56663ba02ff27e8ec847
2018-07-26 14:57:58 +07:00
Zane Bitter
dea4bd18e0 Docs: Reorganise landing page
Consolidate into three sections based on the audience: operator, user, and
developer. Don't include API autodoc inline, just link to it.

Change-Id: I3c301d66dd05698fca3582761cb0177d66431483
2018-04-11 16:32:33 -04:00
ricolin
35047c131f Replace github with openstack git repo
git.openstack.org is our official server, github is just a
read-only mirror.

Linking to github might also raise the expectation that we use the usual
github workflow which is not the case.

Change-Id: I3b3e8213c264757838c8e5fd33221eebf219cdc8
2015-10-21 09:51:40 +08:00
Steve Baker
a2d1b7ee38 Aim first doc link list at end users
This change renames the first doc link section Getting Started to
Using Heat and makes the content relevant to end users of Heat.

End users author templates, create stacks, and use the heat CLI.
They are not necessarily interested in installing heat from packages or
devstack.

This change breaks out the basic create-stack content into its own page
and links to that from the first Using Heat contents list. The rest of
the getting started content is moved to the Developers section for now,
pending later changes aimed at developers and operators.

Change-Id: I79988e08864c5a87ebc4f8f5a39102d50b26f748
2015-10-06 11:38:14 +13:00
Anderson Mesquita
31e970c45d Fix docs for Hello World and WP Single templates
This fixes the existing parameter names and adds missing ones for the
HOT Hello World doc page. It also updates the description of parameters
for the CFN WP Single Instance to match those of the template.

Closes-Bug: #1461515
Change-Id: Ic8ac05c1dcc3f54ec1a88dc391d32ce877931084
2015-08-28 10:58:46 -07:00
Pradeep Kumar Singh
affc4a52f8 Modify heading of the template sample page
Currently the headings for Hello World HOT template
and AWS Wordpress Single Instance Template pages is
"Template". This patch modifies the heading
of these pages.

Closes-Bug: #1337108

Change-Id: Ib1aaf1000f085b1b9568ef4f2322e7519703c838
2015-06-04 19:05:42 +05:30
Masco Kaliyamoorthy
6d4a07f2f7 external link not working in heat doc
In HOT templates document, there is a link
to the example heat template in the github.
The link is not working because there is a _ present
in before the link.

It is removed now.

Change-Id: I65a95b74ec9e902a7eaee0c94b4f320cd20e3ae5
Closes-Bug: #1407892
2015-01-06 15:43:01 +05:30
Christian Berendt
d17bc10c40 Add missing \n at the end of file
Change-Id: Id52a1b24c15ac25044a752e47474dc9ef4096208
2014-10-09 22:06:49 +02:00
Chris Buccella
0891d19a9d Fix dead link in cfn template doc
The link referenced in templates/cfn/WordPress_Single_Instance
is dead. Looks like the directory was restructured. Updated using
a like for the F18 version of the template.

Change-Id: I46705cd31e2be6f3f131c64944665eabe6347dc9
2014-08-06 16:30:33 -04:00
Angus Salkeld
ffc55433d4 Fix the main docs index page
This magic new line makes the main index look a lot better.
It wasn't showing the "HOT templates" level.

Change-Id: I3f7fb65911a4b0f3ad57ddf22c00ec8236261c7e
2013-08-23 09:56:13 +10:00
Angus Salkeld
4b578db8fb Fix all the sphinx-build warnings
except this one:
 WARNING: toctree contains reference to nonexisting document u'api/autoindex'

Change-Id: I176a75c1c3fc9603304f11f867df54d7a7b3610a
2013-08-22 12:41:31 +10:00
Jeff Sloyer
6bfd774df8 add docs from the heat wiki
updated index.rst to mimic the layout of the keystone docs
updated the structure for troubleshooting
ported howto guides from the heat wiki
ported the troubleshooting page from the heat wiki
updated the nav for the man pages and getting started
added docs for a cfn template and hot template

Change-Id: I14c1b0b6aa6ea3529c4de994851f7a798a3061bf
2013-07-17 18:35:18 -04:00