Internal Errigal Collaboration Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Release Flyers ======

The release flyers are created at the end of each sprint alongside the release notes. 

The release flyers are designed to provide a more general overview of the sprint as opposed to the granular ticket-level view of the release notes.

As of IDMS 3.18, the release flyers are generated in the [[https://bitbucket.org/errigal/errigal-document-generation/src/master/|Errigal Doc Generation Repo]] project.

===== Steps To Prepare The Release Flyer =====

  - This assumes the release notes are already completed. These are used as a reference for the release flyer content.
  - Pull the latest version of the doc generation repo.
  - Go to the **inputs > Release-Flyers** directory (file manager or via text editor; I use Typora)
  - Under each customer folder, create a new directory for the current sprint (match existing naming conventions)
  - In each of those folders, create the release flyer markdown file (match existing naming conventions)
  - Copy over the layout of a previous release flyer, ensuring you copy the metadata at the top of the markdown file. This is what's needed to generate the flyer correctly.
  - Update the content of the release flyer accordingly, using the release notes as reference.

===== Steps To Generate The Release Flyer =====
  - Before you can send off the release flyer, you need to generate it in PDF form. Open the doc generator repo directory in the terminal.
  - Run the command to generate a HTML version of the release flyer and output it to outputs > relevant_customer > Release-Flyers
  - Here's some example code: 

''python3 generate-documents.py -g html -i inputs/Release-Flyers/ATC/Release-Flyer-IDMS-3.18/Release-Flyer-IDMS-3.18.md -o outputs/ATC/Release-Flyers''

  - Open the outputted html file in your browser.
  - Right click on the screen and select **Print**.
  - Select **Save As PDF**
  - Set Margins to custom and set left, right, bottom margin to 0mm + set the top margin to 10mm.
  - Ensure it looks visually correct then select Save.
  - Do this for each customer's release flyer.



===== Submitting The Release Flyer =====

  - Add the finished release flyers to the Sprint Management Folder under the relevant sprint Release Notes.
  - **Note** This step might change in future sprints. We are planning to introduce Pull Requests to this process instead of manually moving the release notes + flyer to the drive for feedback.
Sidebar

Internal Errigal Collaboration Wiki

User Tools

Site Tools

Page Tools
