Skip to content

EPIC: Develop 'How To Use Airship 2' Ops/User/Dev Guides #33

@michaelfix

Description

@michaelfix

Enhancement description (if applicable)
As an operator, create (write) an Operations Guide, User's Guide, and Enhance the preexisting Airship 2 Developers Guide (page) in support of the Airship 2.1 release and to qualify specific tasks, constraints, and processes, for consumers to successfully use and adopt Airship 2 for their deployment and configuration needs of cloud infrastructure.

Proposed change
The new and enhanced documentation will reside on the Airship 2 homepage in directory tree to be defined with/by the Airship 2 Documentation Scrum Team. Child/supporting Issues will be utilized to track the individual delivery efforts:

Content for the documents will include, but limited to:

  • Operations Guide: Restart Worker/Control Nodes, Backup, Restore, RBAC, Executing Validation Scripts, Power-down Steps, etc
  • User's Guide: Deployment mechanisms, steps, and prerequisites for deploying workloads.
  • Developers Guide: Repos, Code, Processes, and Steps for contributing to code development.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or requestpriority/mediumsize l5-7+ days - documentation impacting multiple functional areas

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions