This change moves the development guide from
docs.airshipit.org/treasuremap to docs.airshipit.org. It also updates
some content to reference Airship 2.
Change-Id: Icb3474de2cd22e34221f62e1c0a228770fc89cd1
Signed-off-by: Drew Walters <andrew.walters@att.com>
This change adds a job to promote the contents of airship/docs to the
main page of the Airship documentation website.
Change-Id: I3b33c0b72fb1f148bcaaebd33b00bf6171abc697
Signed-off-by: Drew Walters <andrew.walters@att.com>
This patch addresses reviewers need to point to a standart to
follow for Ansible code formatting when contributing to
the Airship project.
It is expected that when code is submitted, it should have
ansible-lint run against it before hand. Later these should be
enforced at the gate.
Change-Id: I67fdfa118a1cdecf8a5bc5224687366a18d60ee5
This change restructures the documentation into three categories that we
will expand on later:
1. Try Airship
2. Develop Airship
3. Learn About Airship
Change-Id: I52286c3b1d87222a436be86b4ab748dba61d080c
Signed-off-by: Drew Walters <andrew.walters@att.com>
This change adds the Airship logo to our documentation.
Change-Id: Ic713b8da8145c073250f2bc7f3229a28f75bd6ee
Signed-off-by: Drew Walters <andrew.walters@att.com>
This change documents the Airship vulnerability management process.
GitHub issues will redirect users here who intend to report Airship
security vulnerabilities.
Change-Id: I2358be70f4bf6b4ede38537e2b078ffb3e2081e5
Signed-off-by: Drew Walters <andrew.walters@att.com>
This adds:
- light YAML schema conventions (camelCase keys)
- CRD conventions (adopting Kubernetes' own API conventions)
This change is borne out of the Airship SIG-YAML agreement that,
for Airship 2.0 work in particular, it makes sense to adhere to
Kubernetes' own conventions in these regards.
Change-Id: I86c7ccae25923242a1104189622e2421460cd350
This patch is migrated from [0] as the repo used to store Airship
docs has changed to airship/docs.
This patch addresses feedback found in the other patch by removing
the manual import order specified to follow PEP8 standards as found
in the OpenStack docs in favor of using the goimports tool.
It is expected that when code is submitted it should have gofmt and
goimports run against it before hand - but these will be enforced
at the gate.
Change-Id: I624bade922e034205643a5214295a0febea7953b
This patch is migrated from [2] as the repository we use for docs
is changing.
Please see [0] for code formatting in progress against the Pegleg
project using the YAPF style added in this documentation.
The goal of the YAPF documentation is to standardize the code base
across all Airship projects. YAPF handles the formatting, and the
provided import order template adds a best practice.
Available YAPF knobs are located at [1], this patch chooses:
blank_line_before_nested_class_or_def: True, for readability of code
blank_line_before_module_docstring: True, for readability of code
split_before_logical_operator: True, when multiple and/or type
statements are in same block it makes it much easier to read when
the operation (and, or) is in front of the next argument on a new
line. This follows common mathematical operations and makes code
more intuitive to read.
split_before_first_argument: True, for consistency. Because of arg
number and length some calls start on a new line, others don't.
This makes them all start on a new line.
allow_split_before_dict_value: True, for readability/consistency.
This keeps key:value pairs on a single line together.
[0]: https://review.opendev.org/#/c/664125/
[1]: https://github.com/google/yapf#knobs
[2]: https://review.opendev.org/#/c/668896/
Change-Id: Ic85e3227253cdf5253bd32dc2ba2c1dbe613c003
