diff --git a/README.activity-report b/README.activity-report index 0f2bde48b36c9215eb7f469e4dec1b5ccf2b1662..0429416a8357ddec08da0f1f8015242a2a8cd4ff 100644 --- a/README.activity-report +++ b/README.activity-report @@ -27,9 +27,9 @@ for any doubt, ask! *** TODO For contributions sent by email: Commit with the author information _Note_: Tracking the name and the email in the commit message is helpful to -contact the contributors again. + contact the contributors again. -_Note_: At worst, add Authored-by: or Co-authored-by: in the commit message +_Note_: At worst, add Authored-by: or Co-authored-by: in the commit message. *** TODO When co-author: Add the trailing Co-authored-by: Alice Carol <alice@carol.org> @@ -40,18 +40,31 @@ _Note_: One Co-authored-by: line per co-author. ** TODO The editor writes the introduction and "Perspectives" section -The introductory paragraphs are mostly boilerplate that presents Guix-HPC. But there is also a sentence or two summarizing the highlights of the year. +_Note_: The introductory paragraphs are mostly boilerplate that presents + Guix-HPC. But there is also a sentence or two summarizing the + highlights of the year. -The "Perspectives" section at the end of the report is a high-level outlook on future directions for Guix-HPC. Challenges, opportunities, etc. +_Note_: The "Perspectives" section at the end of the report is a high-level + outlook on future directions for Guix-HPC. Challenges, opportunities, + etc. Once you have a draft, ask the author community for feedback. + ** TODO Update the PDF cover file with the year (see file doc/build.scm) -The activity report is published in three formats: -- as a blog post -- as a PDF file -= as a PDF booklet file for printing and folding -The last two formats include a nice cover page. It contains the year number, so it has to be updated every year. You may also tweak the graphics for visual diversity, but that's optional. +_Note_: The activity report (Makdown format) is then published in three + formats: + + - as a blog post; + - as a PDF file; + - as a PDF A5 booklet file for printing and folding. + + The last two formats include a nice cover page. It contains the year + number, so it has to be updated every year. You may also tweak the + graphics for visual diversity, but that's optional. + + The current cover PDF file is named + =orbital-spheres-plus-cover-20XY.pdf=. ** TODOs [0/3] **January**: Ask for a last round of collective double-checking *** TODO Check uniformity of Talks and Events @@ -114,14 +127,13 @@ _Note_: See between the lines 249 and 256; guess 251? Where XY matches the current year. -_Note_: - + The report is released on February XY+1. - + The report covers mainly the year XY, - + The cover mentions the years (XY-1)--XY. - + Example: activity-report-2024.md - + release on Feb. 2025 - + main year 2024 - + cover 2023-2024 +_Note_: + The report is released on February XY+1. + + The report covers mainly the year XY, + + The cover mentions the years (XY-1)--XY. + + Example: activity-report-2024.md + + release on Feb. 2025 + + main year 2024 + + cover 2023-2024 ** Template for the activity report