692 Commits

Author SHA1 Message Date
Rodolfo Alonso Hernandez
4254db1c61 Update the "Creating your first stack" document
This patch updates:
* The fedora cloud image used (the previous one is not longer
  available)
* The image name, to match the name used in the "stack create"
  command.
* The link to the "WordPress_Native.yaml"

Trivial-Fix

Change-Id: I845cb19ecc70467606d336850e7154a68208c896
2023-04-12 16:09:33 +02:00
Stephen Finucane
998d8df420 db: Remove legacy migrations
Unlike Cinder, Nova etc., we haven't had any sqlalchemy-migrate-based
migrations in Heat for some time. That means we don't need a transition
period to handle users that may not have the latest
sqlalchemy-migrate-based migration and we can remove these migrations
immediately. Doing so also means we can also remove sqlalchemy-migrate
from our dependencies. Hurrah!

Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Change-Id: I825c58a42e9d430c9d660dae9bb70d1cb6f91079
2023-03-25 03:01:02 +00:00
Stephen Finucane
ecad14368e db: Add initial alembic configuration
No migrations yet: this is simply the output of 'alembic init' with some
minor tweaks.

A note about ordering of requirements is removed from requirements.txt:
it is no longer true with the new dependency resolver introduced in pip
20.3.

Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Change-Id: I7790222ab5eaf6c47dd386fe472275a3037a9898
2023-03-23 11:01:07 +00:00
Zuul
03ddb5be8d Merge "Fix get_attr syntax in template guide" 2022-09-28 08:50:22 +00:00
Zane Bitter
13fbd367e3 Fix get_attr syntax in template guide
Change-Id: I328fbe089731d1d2a2e8aa1a6f05f6621a9201b8
Story: 2010312
Task: 46373
2022-09-27 20:12:46 -04:00
Matthias Runge
78244c5f0f Use f36 instead of f33 for testing
F33 is unsupported for a while. We should not use it for any testing.

Change-Id: I7d1017bcd7147329c4e187336daee1a1ae280fa9
2022-05-31 10:35:53 +02:00
rabi
2c5f6e7a80 Add intersphinx_mapping for sqlalchemy
This would fix the docs build failures with
sqlalchemy 1.4.27.

Change-Id: Iae37cb89667ae95d93eca7ea71122b7de59cee7f
2021-11-17 12:12:52 +05:30
Zane Bitter
315fbc4fd5 docs: Fix typo in developer guide
Change-Id: Ic5e6fa80d2a04b1c36087ed8f7f870e414cd5d82
2021-10-11 10:16:29 -04:00
Zane Bitter
0d1976c988 Don't reference OS::Nova::FloatingIP in the docs
Nova-network is long gone and this resource type has been hidden for
many, many releases.

Change-Id: Id6fd24dad04c5d547368ca54f7210429f27e2b37
Story: 2008978
Task: 42622
2021-06-24 16:33:02 -04:00
Ghanshyam Mann
157f358057 [goal] Deprecate the JSON formatted policy file
As per the community goal of migrating the policy file
the format from JSON to YAML[1], we need to do two things:

1. Change the default value of '[oslo_policy] policy_file''
config option from 'policy.json' to 'policy.yaml' with
upgrade checks.

2. Deprecate the JSON formatted policy file on the project side
via warning in doc and releasenotes.

Also replace policy.json to policy.yaml ref from doc and code.

[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html

Change-Id: I1aa12bcd2638390f25d57ce8abeeec248121dc02
2021-06-17 01:35:45 +08:00
Manpreet Kaur
793f5b37ae [Doc] Moving to OFTC
This patch updates Freenode to OFTC as IRC server in document.

Change-Id: I8049b24601c2c7faf1567452cf550118c6237bbb
2021-06-03 19:39:06 +05:30
Ghanshyam Mann
29573f8fbf [ussuri][goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38524
Change-Id: I41b6fa23569047c8ed877902989a5ebd20c0c189
2021-05-31 20:37:14 +00:00
Zuul
6f26419553 Merge "Remove references to basestring" 2021-03-15 14:05:38 +00:00
Zuul
98dc789fbc Merge "Switch to collections.abc.*" 2021-03-12 08:07:07 +00:00
Zuul
a118f3626b Merge "Fix typo in documentation" 2021-03-11 14:32:34 +00:00
Pierre Riteau
46d31c729b Fix typo in documentation
Change-Id: I018b75dcd28978e13be33a471be64fae3b31f585
2021-02-02 08:32:31 +00:00
Stephen Finucane
164daa691b Remove references to basestring
This doesn't exist in Python 3.

Change-Id: I5aff8a205d524cc15c161a961b0603efeb66a2e8
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-02-01 11:34:43 +00:00
Stephen Finucane
57e9754093 Switch to collections.abc.*
The abstract base classes previously defined in 'collections' were moved
to 'collections.abc' in 3.3. The aliases will be removed in 3.10.
Preempt this change now with a simple find-replace:

  $ ag -l 'collections.($TYPES)' | \
      xargs sed -i 's/\(collections\)\.\($TYPES\)/\1.abc.\2/g'

Where $TYPES is the list of moved ABCs from [1].

[1] https://docs.python.org/3/library/collections.abc.html

Change-Id: Ia282479bb1d466bd2189ebb21b51d91e89b9581e
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-02-01 11:15:59 +00:00
Matthias Runge
6a9c35d898 Move testing to Fedora 33
Now that the gate is unblocked, we can also test F33 for gating purposes
here.

Change-Id: Ie1c9075623d85b27aaf1ac67a3063e219726bc6f
2021-01-19 16:38:43 +00:00
Matthias Runge
61e53c4eca Replace Fedora test image with F32
Fedora 31 was retired and the image is gone from mirrors.
heat-cfntools have been dropped from fedora images, disable
the test till that's resolved.

Also makes grenade job non-voting, till this is backported
to stable/victoria.

Change-Id: Id869f83a46454897c2fe7a532eebfa2863befe5e
2020-12-04 12:18:59 +05:30
Zuul
5eec3e4bd0 Merge "Modify 'if' Macro to allow optional properties" 2020-11-02 17:46:26 +00:00
Zuul
cba6d9b03a Merge "Add template version 2021-04-16 for Wallaby" 2020-11-02 17:45:07 +00:00
Zane Bitter
71a9c3d690 Modify 'if' Macro to allow optional properties
Change-Id: I931d88e79fc077d12fc9bd39009061ffe87f1262
Story: 2007388
Task: 38973
2020-10-27 16:59:30 -04:00
Zane Bitter
674a62ae9b Add template version 2021-04-16 for Wallaby
Change-Id: I57047682cfa82ba6ca4affff54fab5216e9ba51c
Story: 2007388
2020-10-27 16:55:38 -04:00
Zane Bitter
9e6c3212b9 Add U + V release codenames for docs generation
This makes for nicer output in the resource types docs.

Change-Id: I5c7b0e7454df0c5dd33efb03c08d15ea231bf530
2020-08-12 10:06:35 -04:00
Andreas Jaeger
b3e7c590f0 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I4ebb6e663471a7096bd9d0e1a90d8114d1875546
2020-05-21 09:43:55 +02:00
Rabi Mishra
f18a676792 Use Fedora 31 for tests
Change-Id: Ia45e957bb24f5596a5ef16271f71ba8b77df9e42
2020-05-12 11:28:31 +05:30
Hervé Beraud
991e967846 Remove six and python 2.7 full support
Six is in use to help us to keep support for python 2.7.
Since the ussuri cycle we decide to remove the python 2.7
support so we can go ahead and also remove six usage from
the python code.

Review process and help
-----------------------
Removing six introduce a lot of changes and an huge amount of modified files
To simplify reviews we decided to split changes into several patches to avoid
painful reviews and avoid mistakes.

To review this patch you can use the six documentation [1] to obtain help and
understand choices.

Additional informations
-----------------------
Changes related to 'six.b(data)' [2]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

six.b [2] encode the given datas in latin-1 in python3 so I did the same
things in this patch.

Latin-1 is equal to iso-8859-1 [3].

This encoding is the default encoding [4] of certain descriptive HTTP
headers.

I suggest to keep latin-1 for the moment and to move to another encoding
in a follow-up patch if needed to move to most powerful encoding (utf8).

HTML4 support utf8 charset and utf8 is the default charset for HTML5 [5].

Note that this commit message is autogenerated and not necesserly contains
changes related to 'six.b'

[1] https://six.readthedocs.io/
[2] https://six.readthedocs.io/#six.b
[3] https://docs.python.org/3/library/codecs.html#standard-encodings
[4] https://www.w3schools.com/charsets/ref_html_8859.asp
[5] https://www.w3schools.com/html/html_charset.asp

Patch 1 of a serie of 28 patches

Change-Id: Ia310a58ffdc688302b32d57a6bef6b1b8f5d9950
2020-04-22 12:23:44 +02:00
Andreas Jaeger
9e84032750 Fix doc building with Sphinx 3
Sphinx is now warning if the glossary is not properly capitalized, lower
case the entries so that they can be referenced more easily.

Task: 39421
Story: 2007558
Change-Id: Ic0c636db20f6d2fe5b1ad7782d937d01657bb091
2020-04-15 12:29:04 +02:00
ricolin
c739be7645 Migrate doc path to contributor
Migrate document contributing and developing_guides to
contributor.

Change-Id: I6308992451c8d65fb7c1b99c73b801bbf6152999
2020-02-22 14:16:50 +08:00
Zuul
88528fb7de Merge "Docs: Fix links broken since Train release" 2020-02-22 06:14:00 +00:00
Zuul
a94b683978 Merge "Docs: Fix link broken since Stein release" 2020-02-22 06:13:58 +00:00
Zuul
db67ce1cdb Merge "Docs: use extrefs to link to other projects' docs" 2020-02-22 06:11:50 +00:00
Andreas Jaeger
97db901658 [ussuri][goal] Finish dropping python 2.7 support
OpenStack is dropping the py2.7 support in ussuri cycle.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

This change cleans up:
* remove old requirements
* remove universal wheel building, we don't need this for py3
* cleanup setup.py
* tox.ini: move basepython around; remove install_command since the
  default is fine and constraints should be in deps; add
  ignore_basepython_conflict

Change-Id: Ife0a696ca62be21d3d93c5d8279a412578f62697
2020-02-06 18:58:12 +01:00
Zane Bitter
40ec766568 Docs: Fix links broken since Train release
Change-Id: Iccd1185c697d3c44c887ee69ef403c8c4c9ef6fb
2020-01-23 12:31:27 -05:00
Zane Bitter
18f59964a0 Docs: Fix link broken since Stein release
Change-Id: I3c9bdfe1bc40e6b96335041928aed275d1eb4958
2020-01-23 12:30:38 -05:00
Zane Bitter
dd70d9244d Docs: use extrefs to link to other projects' docs
This feature of openstackdocstheme means that we'll always link to the
corresponding branch of another project (i.e. latest links to latest,
but train links to train, &c.)

https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: If94115f87af3689413405f3283be7fb197fab058
2020-01-23 12:30:34 -05:00
Zuul
c0a5eaf6b9 Merge "Replace git.openstack.org URLs with opendev.org URLs" 2020-01-09 19:07:39 +00:00
Zuul
f860a7307d Merge "Remove the unnecessary jeos building docs" 2020-01-09 17:39:58 +00:00
zhulingjie
087efe1a96 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I76d9981c4d0f437f72a442f14c2b2f60e00b4dfc
2019-12-23 19:04:56 +00:00
chao liu
247eaa4cf3 Remove the unnecessary jeos building docs
Since the docs below already describe how to build heat jeos, the jeos
building docs is no longer needed.

https://docs.openstack.org/heat/latest/template_guide/
software_deployment.html#software-deployment-resources

https://github.com/openstack/heat-templates/tree/master/hot/
software-config/elements

Change-Id: I5a9f68419a050e1a6215d6b5a1c18e5182e0734b
2019-12-23 13:16:09 -05:00
huangtianhua
6c48f4d03b Update the default implementation of _show_resource
Give the latest implementation of Resource's
_show_resource in pluginguide.rst.

Change-Id: I21162d68398980d1a7b2cfae9bfe051855b39269
2019-12-23 17:15:03 +00:00
Zuul
28ce9f3ad4 Merge "tox: Keeping going with docs" 2019-12-20 05:26:43 +00:00
Zuul
21aed54e5c Merge "Use resource description as default description property" 2019-12-19 12:33:48 +00:00
Zuul
55d7b1327a Merge "PDF documentation build" 2019-12-05 06:20:45 +00:00
caoyuan
eb10545b37 tox: Keeping going with docs
1. Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.

2. Add whitelist_externals to fix the warning

[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045

Change-Id: I47683ab1313981a8202afe6b3fe1779d40340452
2019-11-01 11:30:12 +08:00
Zuul
9f3ea0a63e Merge "Update osprofiler about doc" 2019-10-22 02:38:22 +00:00
matthew-fuller
debff05779 PDF documentation build
This change provides the necessary modifications to enable
building of pdf documentation. The resources.py extension
required modification to:
  - prevent attributes from being rendered as stray \items
    outside of a list environment
  - prevent update policies from being rendered as stray
    \items outside of a list environment
  - remove the 'Note:' admonition around the 'Not implemented'
    message when it applies to a sub-property, such as a list.
    The admonition was not rendered as a list item, causing the
    build to fail due to an empty list.

Change-Id: Id4e533430600b5ff03fd63cdc09b9a00741b8e4e
2019-10-01 08:57:22 -07:00
Zuul
0d564d933e Merge "Update devel info: mailing list" 2019-09-27 19:41:06 +00:00
Zuul
784863f12a Merge "Bump the openstackdocstheme extension to 1.20" 2019-09-25 15:50:37 +00:00