8 Commits

Author SHA1 Message Date
bijayasharma
ebf35cd8b9 Fixed broken links in Airshipctl docs
Change-Id: I8ba11e7cf35e85c81ff4c001238b1fc9662833c2
Signed-off-by: bijayasharma <vetbijaya@gmail.com>
Relates-To: #644
Closes: #644
2021-09-30 14:25:46 +00:00
Noor Muhammad Malik
2df0b1b331 Guideline against very large Gerrit Changes
This adds a note into the CONTRIBUTING.md file to discourage
creation of extremely large changes in the project that are very
difficult to review.

Change-Id: I416082854024d81cfca1a047e1281f582c3e2fa5
Relates-To: #289
Closes: #289
2020-07-06 20:51:00 +05:00
Drew Walters
203facc35d Remove Read the Docs jobs
Since documentation is stable on docs.airshipit.org/airshipctl, we no
longer need the Read the Docs webhook. This change removes publishing to
Read the Docs so the project can be deleted before other documentation
begins to link to the incorrect place.

Change-Id: I89b3e72626189ecd31971e6d266a0b298d059154
Signed-off-by: Drew Walters <andrew.walters@att.com>
2020-05-18 20:43:36 +00:00
Ian H. Pittwood
25691da17a [#39] Add Zuul job for GitHub Issues integration
Adds a post job to update related issues in Github on change merges. If
a change contains a "Closes: #X" tag, issue X will be closed on merge.
If a change contains a "Relates-To: #X" or "[#X]" tag, a comment will be
made on the associated issue to indicate the change was merged and that
the issue may be closeable.

Closes: #39

Change-Id: Ide9a4d53de7be0e467422938e4e8067fb41ce036
2020-03-02 09:49:27 -06:00
Ian H. Pittwood
c0684561b9 [#37] Change issue tracker info to GitHub Issues
Changes links from Jira to GitHub Issues.

Adds additional information on GitHub Issue workflows, guidelines for
submitting changes, and links to review boards.

Change-Id: I9af8208807f2f0f084a65ca6882f8105f8bca0fa
2020-02-12 11:13:14 -06: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
Alan Meadows
7328c22a3e Initial Contributions and Developer Docs
This commit forms a starting point for our CONTRIBUTING.md
and developer documentation.

Change-Id: I7de8ad19e658a849208c18a3339c1f01a95471d5
2019-11-07 10:48:32 -08:00