Commit Graph

3 Commits

Author SHA1 Message Date
Alexander Hughes
feb8e4e484 [#85] update testing documentation
This change updates testing documentation to take advantage of the
new make target included in [0]

[0]: https://review.opendev.org/#/c/711050/

Relates-To: #85

Change-Id: I25d7ee22f9cc5fcef38354a8eafb17c780240977
Signed-off-by: Alexander Hughes <Alexander.Hughes@pm.me>
2020-03-09 12:00:04 +00:00
Ian H Pittwood
6cb70e7eb3 [#17] Fixes to airshipctl docs
Various typo fixes in documents

Various grammar and language changes for clarification

Change-Id: I111bf45c90405a26d09a5254733a055c78b47407
2020-02-10 19:25:07 +00:00
Ian H. Pittwood
b8a2bb3b27 Updates to Makefile
Implements `make docs` command to create rtd-themed docs using Sphinx
from the existing Markdown documents in the docs directory.

Changes the `get-modules` command to `depend` to more closely match
OpenStack guidelines in [0].

Adds `fmt` command as specified in [0], currently referencing the `lint`
command.

Adds `godoc` command that will host a local godoc server instance with a
link directly to airshipctl technical documentation.

Adds `releasenotes` commands specified in [0], currently
noted as "TODO".

Adds `images` command as found in other Airship projects, referencing
`docker-image`.

[0] https://governance.openstack.org/tc/reference/pti/golang.html

Change-Id: I134fc2c2714bce6d23dc9cf8b86c3016d68def7e
2020-01-10 09:20:10 -06:00