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 Errigal Doc Generation Repo project.

1. This assumes the release notes are already completed. These are used as a reference for the release flyer content.
2. Pull the latest version of the doc generation repo.
3. Go to the inputs > Release-Flyers directory (file manager or via text editor; I use Typora)
4. Under each customer folder, create a new directory for the current sprint (match existing naming conventions)
5. In each of those folders, create the release flyer markdown file (match existing naming conventions)
6. 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.
7. Update the content of the release flyer accordingly, using the release notes as reference.

1. 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.
2. Run the command to generate a HTML version of the release flyer and output it to outputs > relevant_customer > Release-Flyers
3. 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

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

1. Add the finished release flyers to the Sprint Management Folder under the relevant sprint Release Notes.
2. 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.