Mentions légales du service

Skip to content
Snippets Groups Projects
Commit be50f212 authored by Konrad Hinsen's avatar Konrad Hinsen
Browse files

README.activity-report: revision

parent f6e91a30
No related branches found
No related tags found
No related merge requests found
......@@ -3,59 +3,70 @@
#+STARTUP: indent
#+TODO: TODO TODOs | DONE
You are one Editor for the next Guix-HPC activity report, congrats!
You are an editor for the next Guix-HPC activity report, congrats!
This file describes the various steps you need to complete in order to publish
the activity report. **The goal is to publish it on the second week of
February.**
Don’t be afraid by this checklist, that’s a very smooth process. An advice:
Don’t be afraid by this checklist, it’s a very smooth process. An advice:
for any doubt, ask!
* Check list [0/11]
** TODO **Clone** the Git repository https://gitlab.inria.fr/guix-hpc/website
** TODOs [0/5] **November**: Open the activity report
*** TODO Create the folder draft/ if required
*** TODO Create the markwdown file drafts/activity-report-20XY.md
*** TODO Above Template for the file drafts/activity-report-20XY.md
*** TODO Be careful with placeholders from the Template file (XY, etc.)
*** TODO Send an email to all the authors of the previous activity report
*** TODO Create the folder drafts/ if required
*** TODO Create the markwdown file drafts/activity-report-20XY.md and insert the template (see below)
*** TODO Be careful with placeholders from the template file (XY, etc.)
*** TODO Send an email to all the authors of the previous activity report, asking for contributions
*** TODO Contact other potential contributors to the report
** TODO **December** / **January**: Friendly reminder and/or ping
** TODOs [0/4] **Contributions**
*** TODO For contribution sent by email: Commit with the author information
*** 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 again the contributors.
contact the contributors again.
_Note_: At worse, 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>
_Note_: One Co-authored-by: line per co-author.
*** TODO Double check grammar and spelling
*** TODO Do not refrain about the hyperlinks to external resource
*** TODO Do not refrain (?) about the hyperlinks to external resource
** TODO The Editor write the Perspectives section
** TODO The editor writes the introduction and "Perspectives" section
** TODOs [0/3] **January**: Ask for the last round of collective double-checking
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.
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.
** TODOs [0/3] **January**: Ask for a last round of collective double-checking
*** TODO Check uniformity of Talks and Events
*** TODO Check Personnel and ping
*** TODO Check typos, “quotes”, **highlights**, tiret –, space
*** TODO Check the "Personnel" section and ping (?)
*** TODO Check for typos, “quotes”, **highlights**, dashes –, spaces
** TODOs [0/12] **February**: Publishing!
** TODOs [0/12] **February**: Publish!
*** TODO Move from drafts/activity-report-20XY.md to posts/activity-report-20XY.md
*** TODO Be careful with the placeholders from the Template file (XY, etc.)
*** TODOs [0/3] Update the author: header field
*** TODO Be careful with the placeholders from the template file (XY, etc.)
*** TODOs [0/3] Update the "author:" field in the header
**** TODO Alphabetically sorted by last name
**** TODO Tips: git log
**** TODO Do not miss Authored-by: or Co-authored-by:
**** TODO Tips: =git log= / =git blame=
**** TODO Do not miss "Authored-by:" or "Co-authored-by:"
*** TODO Adjust the date: header field
*** TODO Update the PDF cover file with the new year (see file doc/build.scm)
*** TODO Adjust the "date:" field in the header
*** TODOs [0/4] Adapt the file doc/build.scm
**** TODO Replace the placeholder XY in the file [[file:doc/build.scm][doc/build.scm]]
......@@ -66,7 +77,7 @@ _Note_: See the last lines of the file.
"activity-report-2024.tex")
#+end_src
**** TODO Adjust Edited by line (replace the names, put yours)
**** TODO Adjust "Edited by" line (replace the names, put yours)
_Note_: See between the lines 258 and 294; guess 272?
......@@ -74,9 +85,9 @@ _Note_: See between the lines 258 and 294; guess 272?
_Note_: See between the lines 249 and 256; guess 251?
**** TODO Adapt the PDF cover orbital-spheres-plus-cover-20XY.pdf
**** TODO Adapt the PDF cover =orbital-spheres-plus-cover-20XY.pdf=
*** TODO Generate the two PDFs: guix build -f doc/build.scm
*** TODO Generate the two PDFs: =guix build -f doc/build.scm=
*** TODOs [0/5] Double-check the PDFs
**** TODO page numbering
**** TODO empty blank pages
......@@ -84,13 +95,13 @@ _Note_: See between the lines 249 and 256; guess 251?
**** TODO editor name
**** TODO date
*** TODO Try hard to have at least one **bold** for each section, subsection, subsubsection
*** TODO Try hard to have at least one **bold term** for each section, subsection, subsubsection
*** TODO cp $(guix build -f doc/build.scm)/*.pdf doc/static/
*** TODO Locally build the website (see instructions in [[file:README][README]] file)
*** TODO Yeah push! Congrats! :-)
** TODOs [0/3] Spread the word
*** TODO Mattermost
*** TODO Mattermost (?)
*** TODO guix-science@gnu.org
*** TODO your favorite mailing lists
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment