18 Commits

Author SHA1 Message Date
bijayasharma
98bad7dec2 Fixed some typos and links in Airship docs
Signed-off-by: bijayasharma <vetbijaya@gmail.com>
Change-Id: I5d453720a586368d7ca37536511c0043fd418fde
2021-10-05 15:20:13 -04:00
Graham Steffaniak
1a07568bd0 Fix out of date Airship One documentation & broken links
Relates-To: #43

Change-Id: Ib6dee629abd2e4aeb735ec8f580d4e30974afadb
2021-09-10 20:04:20 +00:00
James Gu
566b73583b Fixed broken links after treasuremap master branch rename
A few links to AS1 content source were broken after the master
branch was renamed from v2.

Signed-off-by: James Gu <james.gu@att.com>
Change-Id: Idc63f434b42f9eb0f1923a0775cbed3806bd330e
2021-04-22 11:11:47 -07:00
James Gu
362939f370 Airship V2 baremetal site deployment, provider integration and glossary
Closes: #9

Signed-off-by: James Gu <james.gu@att.com>
Change-Id: Iad56ebee975edbf315a6031fd6c3018b5d022357
2021-04-15 10:51:01 -07:00
James Gu
6ee51e9ca5 Updated toctree to include Airship 2 documentation
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>
2021-04-01 12:45:51 -07:00
Zuul
70068cae17 Merge "Add Layering Documentation" 2021-03-30 16:28:01 +00:00
Matt McEuen
7476793d7a Add Layering Documentation
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
2021-03-05 15:51:35 -06:00
Roman Gorshunov
db9f3a1bd6 Add container image and Dockerfile conventions
Change-Id: I995816bafac0c95fae0618efc239d93f4069d642
2020-10-14 06:24:41 +00:00
Roman Gorshunov
11f52118e6 Add Bash shell scripts formatting documentation
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
2020-10-05 15:24:28 +02:00
Roman Gorshunov
2350e8c64c Add Markdown formatting documentation
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
2020-09-03 10:37:03 +00:00
Drew Walters
951ab6d899 Add more documentation content
This change adds additional content for users landing on
docs.airshipit.org.

Change-Id: Icf791df287d5655833dea8b3b351b093d0cd1c2c
Signed-off-by: Drew Walters <andrew.walters@att.com>
2020-06-12 15:32:47 +00:00
Zuul
acc376171b Merge "Add links to other Airship projects" 2020-06-12 13:31:03 +00:00
Drew Walters
cfb394f85f Add links to other Airship projects
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>
2020-06-11 21:32:19 +00:00
Ian H. Pittwood
b29978f1fa Add issue tracking conventions
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
2020-06-01 14:12:42 -05:00
Drew Walters
2b85e57b5d Remove neglected security guide
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>
2020-05-18 20:27:43 +00:00
Drew Walters
236e109f95 Add development guide
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>
2020-05-11 22:46:52 +00:00
Roman Gorshunov
0eec89a980 Add Ansible code formatting documentation
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
2020-04-23 16:53:31 +02:00
Drew Walters
bc6b004dba Restructure Documentation
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>
2020-03-02 16:04:01 +00:00