572 Commits

Author SHA1 Message Date
Zuul
3a6d724923 Merge "Update docs bug link to storyboard" 2018-07-05 08:57:06 +00:00
Zuul
a4a6a00809 Merge "Docs: Autogenerate config documentation" 2018-06-19 14:56:38 +00:00
Zuul
a3029ddd74 Merge "Docs: include all useful module docs" 2018-06-15 01:27:27 +00:00
Zuul
75b4ce04cb Merge "Replace pbr autodoc with sphinxcontrib-apidoc" 2018-06-15 01:27:26 +00:00
Zane Bitter
e700fbca85 Update docs bug link to storyboard
Change-Id: I9c6cc355b12665036d6faf10773e504a39516056
2018-05-22 21:28:03 +00:00
Zuul
74919e5b00 Merge "Add Rocky versions" 2018-05-02 16:31:16 +00:00
Zane Bitter
7e699d184c Docs: Autogenerate config documentation
The documentation we had of Heat's config options was static and had
last been updated for the Ocata release. Ensure the documentation is
kept up to date by automatically generating it from the source when the
docs are built.

Change-Id: I06b3848451541f8f2d98748c06c556b9dc1104c6
2018-04-27 15:37:17 -04:00
Zuul
3fa4eb4873 Merge "Docs: Make stack domain users docs visible" 2018-04-27 14:47:46 +00:00
Zuul
7d4b0e2adb Merge "Docs: modernise links" 2018-04-27 11:36:18 +00:00
Zuul
ac8bb29cd3 Merge "Docs: Fix broken external links" 2018-04-27 11:09:57 +00:00
Zuul
0ae3b75439 Merge "Docs: use local references for internal links" 2018-04-27 11:09:56 +00:00
ricolin
6665d9989f Add Rocky versions
* Add Rocky code name
* Add new HOT version for Rocky release
The new version is "2018-08-31" or "rocky".
* Add sem-ver flag
Sem-Ver: api-break

Change-Id: I261b6c28b8b7ee9e75ca9a895155a656ef82cd0d
2018-04-26 14:44:03 +08:00
Zuul
5b785eb227 Merge "Fix indentation in hot_spec.rst" 2018-04-24 08:41:52 +00:00
Zane Bitter
3f98c3d6fb Docs: modernise links
Switch to https, replace outdated URLs with canonical ones.

Change-Id: I7c474dbf0b21f922b6625e31d6ae7df1e198b8de
Co-Authored-By: chenghuiyu <yuchenghui@unionpay.com>
Co-Authored-By: Max Pavlukhin <pavlukhinm@gmail.com>
Co-Authored-By: yfzhao <dsware@126.com>
Co-Authored-By: ricolin <rico.lin@easystack.cn>
2018-04-11 16:46:07 -04:00
Zane Bitter
9e5d6b56c0 Docs: Fix broken external links
Change-Id: Iad15069ccee42c1d409915f79e0d8af8e124fe48
Closes-Bug: #1710084
2018-04-11 16:46:07 -04:00
Zane Bitter
b78e78d8bb Docs: use local references for internal links
Some internal links in the documentation are broken after the
re-organisation because they used absolute URLs. Use :ref:, or at least
:doc: instead and let Sphinx take care of keeping the links up to date.

Also add a redirect for docs we know to have moved, since they may be
linked from other places externally.

Change-Id: I107f40e23a757052da7f5179338f88369a4a72cb
Partial-Bug: #1710084
2018-04-11 16:46:07 -04:00
Zane Bitter
0118a1fbcc Docs: include all useful module docs
The list of modules to exclude from autodoc was set some time back, and
is pretty arbitrary looking. Lots of modules that would be useful to a
Heat developer to see documented (e.g. all of heat.common, heat.db) were
not documented, while some other fairly useless ones were.

Change-Id: Ie3aa5bbe8deb8d07eef5fcc352e349a1fa7c68bc
2018-04-11 16:35:33 -04:00
Zane Bitter
96e97013f1 Replace pbr autodoc with sphinxcontrib-apidoc
This fixes local building of the documentation using tox, and allows the
gate to stop relying on pbr and move completely to the new docs PTI.

http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: I6ef3e102f5a169262efbbaeec61452f0a2443fb4
Depends-On: https://review.openstack.org/560577
2018-04-11 16:35:01 -04: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
David Rabel
833abe43fa Fix indentation in hot_spec.rst
Current indentation is wrongly interpreted as quotation.

This patch fixes that issue.

Change-Id: I0372e2d19036930d3d6795d363a0bc71e968fabc
2018-04-06 18:38:52 +02:00
Zane Bitter
2361bd5a48 Docs: Make stack domain users docs visible
This document was effectively hidden because of a misspelling in the
index.

Change-Id: If1bb64f042f38fadfb71dfd58aa854211ffe3d8a
2018-03-15 20:16:21 -04:00
Thomas Herve
346e5561b5 Fix doc build
Sphinx 1.7 removed the Directive from the compat module. Let's use the
docutils version.

Change-Id: I22972feea961f0eb2996d605ff98bbe1f5df2711
2018-03-03 10:51:07 +01:00
Zuul
df7920913b Merge "Fix typo in contributing/blueprint.rst doc" 2018-02-21 01:15:13 +00:00
Zuul
d562bcb46d Merge "include sample config file in docs" 2018-02-11 08:45:49 +00:00
David Rabel
38b961d6d5 Fix hot_spec.rst in Template Guide
Add missing space and words in
doc/source/template_guide/hot_spec.rst

Change-Id: Ic0e5c827d04b78c337c6562df73b5bd1ccf2a977
2018-02-07 08:09:42 +01:00
ricolin
46d1e89c27 include sample config file in docs
Leverage oslo.config to rebuild our sample config file in docs.

Change-Id: I359e63fad43a5fcde4fe30a97cbed8f4f71961c5
2018-02-01 15:38:25 +00:00
rabi
f62167f3de Remove heat-api-cloudwatch from man pages list
Change-Id: I603a3be18ff4cd9b3c7db8a4728d0ac864d0b089
2018-02-01 18:50:23 +05:30
rabi
d3ea2918a3 Cleanup remaning doc for CloudWatch API
Change-Id: I0423dba4eb2a9ddfd7419869ac5943638786a282
Partial-Bug: #1743707
2018-02-01 05:24:05 +00:00
Zuul
04be5a736e Merge "Remove CloudWatch API" 2018-01-31 19:29:03 +00:00
Zuul
54dd15cfd8 Merge "Updated the template guide." 2018-01-30 07:03:13 +00:00
rabi
6d55417f80 Remove CloudWatch API
This patch removes the API, the next set of patches in the
series would remove stack watch service and related
WatchRule implementation.

Change-Id: I8b0472be862907298c8da51f435b5d8b19610ec3
Partial-Bug: #1743707
2018-01-28 09:11:17 +05:30
Zuul
4cbec2c07a Merge "Remove potential co-gating integration tests" 2018-01-27 06:35:21 +00:00
ricolin
ba86129965 Remove potential co-gating integration tests
This patch propose to use heat tempest plugin for potential
co-gating integration tests.
These tests are consider as potential co-gating. And we now
already maintain them in heat tempest plugin.

This also disables all except two of the gate/test jobs, to enable us to
land this series and stop the carnage. The jobs will be re-enabled once
all of the duplicated tests have been eliminated.

Change-Id: I55e204b72cd5a2876576852b10ad09f24d04beb4
2018-01-26 17:50:26 -05:00
Zuul
8dbc4977f1 Merge "docs: fix user-data end user guide link" 2018-01-26 21:10:24 +00:00
Matt Riedemann
9a5252ae6e docs: fix user-data end user guide link
The user-data doc has moved out of the openstack-manuals
repo and into the nova docs, so this updates the link.

Change-Id: I6fac7128f8c099deaea31b3834cab0e472bc10fe
Closes-Bug: #1714017
2018-01-26 20:23:51 +00:00
liumk
a69c2f4bb4 fix a typo in heat-manage.rst: s/covergence/convergence/
Change-Id: If5da5974162209b7f8f513f65d2d2050ba2c4c59
2018-01-22 04:07:59 -05:00
ricolin
222a8ac5e9 [policy in code] part 7 add sample and releasenote
Since we're moving all policy into code and documenting it there we
should generate those docs automatically, so they are less likely to
be out-of-date.
Also add releasenote for ops to aware that Heat is now using
policies in code and their Orchestration service needs to avoid
depends on policy.json file if file not exist, since there is no
such file by default after this patch.
Partially-Implements: bp policy-in-code

Change-Id: I25fc5a110b1fe515918e042f220c23ac9a7e811f
2017-12-13 10:58:56 +08:00
Zuul
218c182fbb Merge "Remove SSLMiddleware" 2017-11-27 03:36:19 +00:00
Zuul
0af0bcd2d1 Merge "Added tags attribute to the template parameter" 2017-11-16 12:29:33 +00:00
Saravanan KR
a1a0609e8e Added tags attribute to the template parameter
In some scenarios, it is required to categorize the parameter.
Associating tags with the parameter, it is will be easy to
categorize the parameter and add simple validations to users.
This patch introduces a new attribute 'tags' with the parameters,
which is a list of strings.

Change-Id: I20fc95d606b0b8a08d3b46bf33f4860bff49c74f
2017-11-13 15:51:19 +05:30
Zane Bitter
6c8697442e Do deep redirects from old docs.openstack.org URLs
The docs.openstack.org site was rearranged so that the old docs at
/developer/heat/ are now at /heat/latest/. The base .htaccess file in
openstack-manuals redirects everything in the old hierarchy to the root
of the new one unless there is a .htaccess file present (see
I0af0e32d9c646d61f4c72599cdc4613299aa5ec9).

Add a .htaccess file so that old links redirect to the equivalent page
in the new location.

Change-Id: I74de09f4e25c2eda050053d3b8646586c9f24c04
Closes-Bug: #1722820
2017-11-02 16:25:01 -04:00
ricolin
f2fd3884e8 Remove SSLMiddleware
We deprecate SSLMiddleware in 6.0.0, and announce to remove it at
8.0.0. Now will be a good time to remove it out.

Change-Id: Iaf9be21ffcec9018ad91a5122ed7f2477a7e4a52
2017-10-18 02:19:46 +00:00
ricolin
a4f2dccf0e Correct example for list_concat-unique function
Change-Id: I330a265a16b0d7a2ac9f94e859f7b81f1e193dc5
2017-10-12 18:56:27 +08:00
Jenkins
0de1e372c7 Merge "Minor doc fix: tmpl_diff argument for handle_update" 2017-09-08 06:40:10 +00:00
Monty Taylor
584a5b0ba5
Remove vestigate HUDSON_PUBLISH_DOCS reference
This isn't actually used and is a leftover from a thing we did
seven years ago that survives today through copy-pasta.

Change-Id: I7fed29322e00fa72b949692e01d821faa3f718ba
2017-09-02 08:44:52 -05:00
Jenkins
ccfb868f72 Merge "* Add new HOT version for Queens release" 2017-08-23 09:20:36 +00:00
Jenkins
8afa507ffd Merge "* Add Queens version '10.0.0' in doc" 2017-08-23 08:10:44 +00:00
npraveen35
e18a523c99 heat config eliminate ec2authtoken
eliminate [ec2authtoken] section, if auth_uri is specified in
'clients_keystone' section

Change-Id: Ie11139a5d9a176037f1c9f50a62ff6dbd1b20b8f
Closes-Bug: #1705664
2017-08-22 04:03:15 +00:00
huangtianhua
c3546d9309 * Add new HOT version for Queens release
The new version is "2018-03-02" or "queens".

Change-Id: Icbb7ff4d717dd10d18a93387edfdb8fcee3d7927
2017-08-22 10:03:18 +08:00
huangtianhua
20a0a48d74 * Add Queens version '10.0.0' in doc
Change-Id: Id99503e561ce112c0e4803ca1566be3186c1bd31
2017-08-22 09:49:04 +08:00