openstack
/
charm-guide
Code Issues Proposed changes
OpenStack Charms development and usage documentation
794 Commits 10 Branches 0 Tags 8.5 MiB
Python 100%
Go to file
Frode Nordahl 2099dfd654 Advise user to disable version pinning after upgrade 
Now that the ovn-chassis charm has the ``enable-version-pinning``
configuration option, which has been backported to the 22.03 charm,
advise user to disable version pinning after completing the 20.03
to 22.03 upgrade.

pmatulis:

* Clarify wording around versions and upgrades.
* Add a table of contents due to the length of this page.

Related-Bug: #2030944
Closes-Bug: #2042478
Signed-off-by: Frode Nordahl <frode.nordahl@canonical.com>
Change-Id: I4e081814a0df2e11aeb4f61775b549828fdeaf89
 		2024-01-19 12:45:53 -05:00
doc Advise user to disable version pinning after upgrade 2024-01-19 12:45:53 -05:00
.gitignore Initial baseline of OpenStack Charm documentation 2016-06-20 11:59:38 +01:00
.gitreview OpenDev Migration Patch 2019-04-19 19:39:52 +00:00
.zuul.yaml Add a spellchecker 2022-04-11 12:45:10 -04:00
HACKING.rst Add deploy guide link and release schedules 2017-11-27 19:52:38 +00:00
LICENSE Initial baseline of OpenStack Charm documentation 2016-06-20 11:59:38 +01:00
README.md Enhance doc contribution guidelines 2022-03-14 11:23:19 -04:00
bindep.txt Add a spellchecker 2022-04-11 12:45:10 -04:00
rebuild Rebuild to republish 2018-06-11 16:15:04 -05:00
requirements.txt Up sphinx for Python 3.10 - Jammy 2023-01-03 13:01:03 -05:00
setup.cfg Remove some deprecation build warnings 2023-01-09 10:45:39 -05:00
setup.py Initial baseline of OpenStack Charm documentation 2016-06-20 11:59:38 +01:00
tox.ini Add linkchecking 2022-09-18 12:20:20 -04:00

README.md

OpenStack Charm Guide

tags

The OpenStack Charm Guide is the main source of information for the OpenStack Charms.

Building

To build the guide run this simple command:

tox

The resulting HTML files will be found in the doc/build/html directory. These can be opened individually with a web browser or hosted by a local web server.

Contributing

This repository is under version control and is managed via the OpenStack Gerrit system (see the OpenDev Developer’s Guide). The Documentation contributions page outlines how to contribute to this project.

Bugs

Documentation issues can be filed on Launchpad.