https://github.com/openstack/charm-guide

OpenStack Charms development and usage documentation. Mirror of code maintained at opendev.org.
https://github.com/openstack/charm-guide

Last synced: about 1 year ago
JSON representation

OpenStack Charms development and usage documentation. Mirror of code maintained at opendev.org.

• Host: GitHub
• URL: https://github.com/openstack/charm-guide
• Owner: openstack
• License: apache-2.0
• Created: 2016-06-27T16:24:49.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2025-03-12T15:16:51.000Z (over 1 year ago)
• Last Synced: 2025-04-09T11:52:42.427Z (about 1 year ago)
• Language: Python
• Homepage: https://opendev.org/openstack/charm-guide
• Size: 1.68 MB
• Stars: 13
• Watchers: 6
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# OpenStack Charm Guide

[![tags][image-badge-cg]][image-link-openstack-tags]

The [OpenStack Charm Guide][cg] is the main source of information for the

[OpenStack Charms][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][gerrit-openstack] (see the [OpenDev Developer’s

Guide][opendev-dev-guide]). The [Documentation contributions][cg-doc-contrib]

page outlines how to contribute to this project.

## Bugs

Documentation issues can be filed on [Launchpad][lp-bugs-cg].

[image-badge-cg]: https://governance.openstack.org/tc/badges/charm-guide.svg

[image-link-openstack-tags]: http://governance.openstack.org/tc/reference/tags/index.html

[cg]: https://docs.openstack.org/charm-guide

[openstack-charms]: https://launchpad.net/openstack-charms

[lp-bugs-cg]: https://bugs.launchpad.net/charm-guide/+filebug

[gerrit-openstack]: https://review.openstack.org

[opendev-dev-guide]: https://docs.openstack.org/infra/manual/developers.html

[cg-doc-contrib]: https://docs.openstack.org/charm-guide/latest/community/doc-contrib/index.html