This commit updates the developers.md file with the files where proxy
have to be set. Also give an example of user-data for proxy setting
in ephemeral node.
Depends-On: https://review.opendev.org/#/c/723057/
Change-Id: I9812cee8cd76807353c05aca1dc4ff9adba62f9b
Signed-off-by: Sreejith Punnapuzha <sreejith.punnapuzha@outlook.com>
This commit cleans up the command constructors in an attempt to make the
codebase more uniform and approachable. This includes several refactors:
* Removed the FlagConstants - this makes the help messages and examples
significantly more readable without needed to compile and run
airshipctl
* Long help messages and examples are now constant
* Short, Long, and Examples all begin with a capitol letter
* Flag descriptions begin with a lowercase letter. This matches the flag
description for the builtin "help" flag, making formatting uniform for
all flags
* Removed redundant unit tests on non-leaf commands
This change also updates the documentation for the affected commands.
Change-Id: I8b9dcbfd9846b3deaab06dec17f80643dae78de9
There are currently no guidelines provided for using airshipctl behind a
corporate proxy server even though additional configuration is
necessary.
This change adds a simple proxy guide that outlines the requirements for
running airshipctl behind a simple proxy server.
Change-Id: I7b4959e1758ff4dfccdf3aec0e569aa77214bd3e
Signed-off-by: Drew Walters <andrew.walters@att.com>
This patch updates the develop documentation in docs/source/developers.md.
Adds details on environment setup and uses some of the scripts available
in tools/gate directory.
Change-Id: I76d426746f668f89ab4f9e43ac00f75f47735702
Relates-To: #72
Closes: #72
1. Add end-user documentation of CLI commands
2. Minor refactor of several help messages
3. Update of golden test data to reflect help message changes
Change-Id: I58b8ac3a7871efdb569887ab65191bfb1842c24e
Signed-off-by: Alexander Hughes <Alexander.Hughes@pm.me>
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>
This change adds the Airship logo to our documentation.
Change-Id: Ie3d068eea2e3545fa38f35f6f7a1e1869360ffac
Signed-off-by: Drew Walters <andrew.walters@att.com>
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
- Links to CONTRIBUTORS.md and testing-guidelines.md were broken.
- Minor fix to escaping of the (c) bulletpoint in contribution
guidelines.
Change-Id: Iffb5233b50008a4e4e4fd17be483d7e8c1ee4856
This patch makes minor documentation fixes:
1. Wording of make images
2. Document rendering of bullet point c instead of a copyright symbol
3. Fix broken link for contributing docs
4. Use https for quay link instead of http
5. Limit line lengths to 80 characters
Change-Id: I8c6d339251e454b357d6eaeb125b925c209e8577
* Documents the expectations for unit-tests
* Updates the tests to the version command so as to provide a clear
example of how to test commands.
Change-Id: I3fbb509a2e4298b4ae68200764a6034459b61602
