Commit Graph

6 Commits

Author SHA1 Message Date
Peter Matulis dc42e0532a Convert README to markdown
Convert the README file from reST to markdown
as the GitHub support for reST is poor (the
current links are broken) and it's more
consistent with the charms to have a README
in markdown.

The CG is being changed in the same way:
https://review.opendev.org/c/openstack/charm-guide/+/782845

Change-Id: I20107e9d8ea8945d7138f1c5d2609b46519d3d42
2021-03-24 15:14:27 -04:00
Peter Matulis 1e20cf3a0f Review README
Improve organisation

Provide better information

Use proper formatting

Change-Id: I06aef99300b317843b38d5594b55cf1c4f690a69
2021-02-17 12:39:13 -05:00
Alex Kavanagh 0b4174c0e4 Add links to bugs and developer's guide
This is so that people can contribute bugs/feature requests, or be
able to submit changes to the documentation.

Also, due to strangeness in the zuul guide merging process, added
a guid in enable-merge to get it to merge the commit.

Change-Id: Id94f89779cc8ec672ef351f84efa04e98155663e
2018-05-08 15:43:51 +01:00
Alex Kavanagh 4493b86a4a Move doc to deploy-guide for the documenation
And remove the build-sphinx part of the python module setup as there
are no docs to build.  This is to make this project (which has no
project documenation, but does have a deploy-guide) compatible with the
other deploy-guides.

Depends-On: I96d8e3d958081667df5e69e148e13c6b27c34767
Change-Id: If775b98b4a58cc956e487a6d566d62999eaaf12d
2017-10-17 15:19:35 +00:00
James Page 2ac01b8a9f Add README 2017-07-13 12:12:19 +01:00
James Page 6f73e1681f Extra bits 2017-06-19 10:43:50 +01:00