Release Process

Prepare documents
Work stream which plan to be released must prepare the following documentation.

1. Architecture document
   This document provides examples of use cases and the overall architecture for implementing them.
   Example) Robot basic architecture based on SSES Architecture - Akraino - Confluence

2. Installation document
   This document describes how to install Open Source Software and Open Source Software stacks which each work stream provides to achieve use cases.
   Example)Robot basic architecture based on SSES Installation Guide - Akraino - Confluence

3. Test document
   This document describes test items and test results about Open Source Software and Open Source Software stacks which each work stream provides.
   The followings are example of test items.
   Installation, Test scenarios to verify Open Source Software itself
   Example) Robot basic architecture based on SSES Test Documentation - Akraino - Confluence

4. Release note
   This document describes what this release provides, changes from previous release and known limitations.
   Example) Robot basic architecture based on SSES Release Notes - Akraino - Confluence

5. One pager
   This document provides an overview of each workstream in 1~2 pages to be referred to the executive level.
   Example) Robot basic architecture based on SSES One Pager - Akraino - Confluence

6. API documentation, API map showing relationship with other LF Edge projects
   - to be discussed -
   
   

Prepare log files
Each workstream must publish the following log files as a source of information to determine whether or not the workstream is installed correctly when someone outside the community uses the workstream.

1. Installation log

2. Test log

3. Security log(Lynis, Vuls)
   Refer to Steps To Implement Security Scan Requirements - Akraino - Confluence about how to execute security scan.
   
   

Review by TSC
The TSC checks that each item is available. The quality of each item should be ensured in each workstream.