openstack
/
charm-guide
Code Issues Proposed changes
OpenStack Charms development and usage documentation
646 Commits 10 Branches 0 Tags 8.5 MiB
Python 100%
Go to file
Peter Matulis d2a9a6380a Add linkchecking 
Enable the built-in Sphinx 'linkcheck' builder and
fix initial findings.

Add this as an opportunistic build target only. The process is
long, and false positives are common (mostly anchor-related
for some reason). There is also already a third-party
company-wide service in place. This builder however will lead
to better link hygiene as it is stricter (mostly for anchors).
It also records all redirects, which should eventually be
replaced by proper links.

Change-Id: Ibed74b9f820c17a5984a78f4f61153e0499453fa
 		2022-09-18 12:20:20 -04:00
doc Add linkchecking 2022-09-18 12:20:20 -04: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 Add new charm delivery page - Charmhub 2022-04-29 18:45:30 -04:00
setup.cfg Convert README to markdown 2021-03-24 15:10:23 -04: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.