This adds some Airship 1 documentation that Rodolfo authored to
describe the end-to-end Airship 1 deployment flow.
Change-Id: Ie1d2ecfa2cc3ba9883ffcfbc238b8f3499def9da
Airship 2 basic documentation to define Consumer of AS2, the Gap/Issue being solved by AS2, and the Evolution with Benefits of Airship 2 from Airship 1.
Closes: #6
Signed-off-by: Mike Fix <michael.fix@att.com>
Change-Id: I09e48e7a363744f8aad2b99e255f6227307f9564
Added placeholder AS 2 document files and updated toctree for landing
AS 2 documents
Signed-off-by: James Gu <james.gu@att.com>
Change-Id: I5229a76ada4b13197a65147edce831dae6788b36
Signed-off-by: James Gu <james.gu@att.com>
Document our approach to layering and de-duplication, so that it
can be understood by users and developed by developers.
This leaves some TODOs in the documentation, with the intent that we
can fill those in over time.
Change-Id: I74f58892db4e5f14a7d8c99ddb04917225cb2ff2
Relates-To: #316
To support SEO tatctics I have added a glossary of terms. The
terms the terms added are: kubernetes, lifecycle management,
orchestration, openstack ironic (OpenStack bare metal provisioning),
bare metal, provisioning Openstack ironic, container orchestration
platform, network function virtualization infrastructure, and
software defined networking (sdn). A full list of terms and
definitions can be found here:
https://etherpad.opendev.org/p/Airship_Glossary. Edits to index have.
also been made
Change-Id: Ifd9bc2bb30859fab3fd9af4e3e456daf7e91b3e7
This patch addresses reviewers need to point to a standard to
follow for Bash shell scripts formatting when contributing to
the Airship project.
It is expected that when code is submitted, it should have
shellcheck run against it before hand. Later these should be
enforced at the gate.
Change-Id: If9a76c90a3d21ddabf8a5bc4d065dc44abe1f4c8
This patch addresses reviewers need to point to a standard to
follow for Markdown formatting when contributing to
the Airship project.
It is expected that when code is submitted, it should have
markdownlint run against it before hand. Later these should be
enforced at the gate.
Change-Id: I7ddf0cf36456dedf1382bf52c61587c0f8e3ef8d
This change finalizes the documentation theme and adds links to other
projects on docs.airshipit.org.
The Airship 1 projects will be added once they are publishing.
Change-Id: I6796e2cf8e4d9f8e1b29f831f09bf3eb4aa3257a
Signed-off-by: Drew Walters <andrew.walters@att.com>
Adds documentation for issue tracking in Github Issues for Airship
projects. Documentation covers issue submission, grooming, lifecycle,
and the Gerrit-to-Github-Issues bot.
Change-Id: I9833043ff53fbc3a68021dd3347c754821ec334b
The Airship security guide was last updated in 2018 and has not been
maintained. It's coverage is limited to Airship 1 and is vague. This
change removes it.
Change-Id: Ibb8a74f6a13d0e66dba92e45ff4891eb25327ce9
Signed-off-by: Drew Walters <andrew.walters@att.com>
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
