From 673afd932c44c68cc86095f2c7d8dae7c4ad247b Mon Sep 17 00:00:00 2001 From: Charles N Wyble Date: Wed, 18 Dec 2024 11:22:55 -0600 Subject: [PATCH] made readme reflect new reduced scope --- README.md | 47 ++++------------------------------------------- 1 file changed, 4 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index a13be5c..88e1256 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,8 @@ # DailyStakeholderReport-Pipeline -- [DailyStakeholderReport-Pipeline](#dailystakeholderreport-pipeline) - - [Introduction](#introduction) - - [Scripts](#scripts) - - [Start a new day](#start-a-new-day) - - [Create a new (blank) DSR](#create-a-new-blank-dsr) - - [Populate the new DSR with objectives for the day](#populate-the-new-dsr-with-objectives-for-the-day) - - [End the day](#end-the-day) - - [Collating and Publishing the report](#collating-and-publishing-the-report) - - [Gathering data for the report](#gathering-data-for-the-report) +This repo is very similiar to my other markdown/PDF micro servcies. -## Introduction +It... -I publish a daily stakeholder report to the TSYS Group discourse every day. Up until 11/29 I was performing the publishing step manually. On 11/29 I automated the pdf creation and publishing to discourse procedure. - -I also begin work on automated gathering of data going into the new version of the report that is in development. - -## Scripts - -### Start a new day - -Start a new day. See the script: **endstops/start-day.sh** - -#### Create a new (blank) DSR - -See the script: **dsr-joplin-create/dsr-new.sh** - -#### Populate the new DSR with objectives for the day - -See the script: **dsr-joplin-create/dsr-populate-objectives.sh** - -### End the day - -End the day. See the script: **endstops/end-day.sh** - -#### Collating and Publishing the report - -Publishing the report involves three steps: - -1. Exporting the markdown from Joplin (and any attachments (i often take screenshots throughout the day)) I am still doing this manually due to having issues installing the Joplin CLI. - -2. Creating a (formatted/styled) PDF from the exported markdown/attachments. See the script: **dsr-publish/create-dsr-pdf.sh**. - -3. Uploading the PDF to discourse and creating a new topic in the appropriate category. See the script: **dsr-publish/publish-dsr.sh** - -#### Gathering data for the report \ No newline at end of file +- Renders a yaml template using values passed in by the calling microservice. +- Uses pandoc with the rendered yaml template to create a PDF.