WP1 openly reporting for the ExPaNDS project. Page building at https://expands-eu.github.io/WP1-reporting/.

Local builds

For local builds, you will need to install Jekyll.

~ $ gem install bundler jekyll
~ $ git clone [email protected]:ExPaNDS-eu/WP1-reporting.git
~ $ cd WP1-reporting
~/WP1-reporting $ bundle exec jekyll serve
# now browse to http://localhost:4000 and tada

Maintenance

Here all you need to know to maintain the site.

• Case 1: add PEB minutes
• Case 2: submit a deliverable to the EC
• Case 3: achieve a milestone
• Case 4: update a progress report

Case 1: add PEB minutes

Preliminary steps (off GitHub)

1. Copy this google doc in a new doc of your own, to have editing rights.
2. Overwrite it with the minutes from the newest PEB - no need to keep native copy of all minutes.
3. Send the link to your google doc in suggesting mode to peb at expands.eu for review.
4. Wait 24 hours.
5. Take comments into account.
6. Download final google minutes as .pdf, add the date of the meeting to the filename and upload it to Sharepoint > General > Meetings > Project Executive Boards - this is your safe storage for auditing purposes.

Back to GitHub

1. In /_pebs, duplicate template.html.
2. Rename it with date of the meeting in standard format YYYY-MM-DD-notes.html.
3. Remove first line published: false.
4. Update list of first name of attendees - it is public so we avoid full names.
5. In intro:, copy from the google doc whatever is before the "Status quo per WP" chapter. Use <h2> if you have several topics, further down is not defined in css.
6. In status-quo:, as you can see from the template, it's a list, so status-quo[0] (what comes after first hyphen) will go into the WP1 sub-chapter, status-quo[1] into the WP2 chapter, etc. You need to copy from the google doc each chapter into the corresponding list item.
7. in aob:, copy from the google doc whatever is after the "Status quo per WP" chapter. You can also add appendixes here. You'll find examples in the previous minutes (e.g. 2021-09-28).

Tips

• Beware to stay between the "" of the template, e.g. intro: "...", even if your text is super long. Careful with links or quotes in text: if there is a " somewhere, you'll need to escape it or use ' instead. Jekyll will complain if you miss one.
• Be as true to the original format as possible, especially bold words <b> and links <a href=''> otherwise the rendering is really boring.
• Be clean and use html tags everywhere, even if it manages without.
• Don't delete any front matter property, even if there is nothing to report in a WP or in the whole status-quo:, or even in aob:. Just leave it empty as in the template.
• You'll notice the "Actions / ToDo Items" table is not included in the public reporting page. This is because they are quickly obsolete. Be sure to keep them in the living google doc as long as they are ongoing though, so you can monitor them. You can send a copy of the oen actions table in the e-mail to the PEB with the agenda for next meeting.
• You may also notice you've only changed the front matter (that is what is between the two ---) in your YYYY-MM-DD-notes.html file. That is supposed to be the case, so no worries. See Jekyll doc if you are curious.
• If there is a new PEB member, you can update the template.html file to include her/him in the default list of attendees.

Case 2: submit a deliverable to the EC

Preliminary steps (off GitHub)

1. The author copies the ExPaNDS doc template in a new doc of his own.
2. The deliverable is written and reviewed.
3. You or the author reserves a DOI in Zenodo and includes in the deliverable, following these good practices.
4. Once the document is reviewed internally and finalised, the author uploads .pdf and native version (or google doc link) in Sharepoint > Deliverables.
5. You or the author uploads the .pdf version of the document in Zenodo and publish it. Careful, you need to add in the Additional notes a disclaimer that it is not yet approved by the EC (see ExPaNDS issue #28 and Zenodo good pratices for ExPaNDS).
6. You upload the .pdf version of the deliverable in the EC portal.
7. You update the Deliverables.xslx table in Sharepoint > Deliverables.

Back to GitHub

1. In /_data open deliverables.yml.
2. Look for your deliverable, id being the deliverable number.
3. Add its doi or if it has another PID type, add it using link.
4. Update the date if needed to fit with the actual delivery date to the EC.
5. Update the status to delivered.
6. Add a description. Try to keep the same tone and length as the other deliverables' descriptions, that is: short and standalone.

Tips

• When a deliverable is accepted by the Commission, you can remove the disclaimer in Zenodo and change its status in deliverables.yml to accepted.

Case 3: achieve a milestone

Preliminary steps (off GitHub)

1. Once a milestone is considered achieved, upload any necessary justification material to SharePoint > Milestones. Can be in Zenodo too if relevant (see example here).
2. Agree on a short justification text with the WP leader of this milestone for the Commission.
3. Tick the milestone box in the EC portal and include the above justification in the comments box.
4. Update the Milestones.xlsx table in Sharepoint > Milestones.

Back to GitHub

1. In /data_ open milestones.yml.
2. Look for your milestone using the id.
3. Update the date if needed to fit with the actual achievement date.
4. Update the status to achieved.
5. Add in comments the justification, exactly as it was entered in the EC portal.
6. (optional) Add its doi or if it has another PID type, add it using link.

Case 4: update a progress report

Preliminary steps (off GitHub)

1. Have a dedicated WP meeting with one WP leader, her/his co-leader, her/his deputy if applicable, the technical coordinator and the project coordinator.
2. Copy the corresponding google doc (WP1, WP2, WP3, WP4, WP5 or WP6) in a new doc of your own, to have editing rights.
3. Take minutes in your google doc and agree on final text with participants.

Back to GitHub

1. In /_reports, duplicate template.html.
2. Rename it with date of the meeting and WP in standard format YYYY-MM-DD-WPx.html.
3. Remove first line published: false.
4. Fill in WP number in wp: "x"
5. In progress:, as you can see from the template, it's a list, so progress[0] (what comes after first hyphen) will go into the task 1 sub-section, progress[1] into the task 2 section, etc. You need to copy from the google doc each progress section of each task into the corresponding list item.
6. Same with next-steps:, copy from the google doc each next steps section of each task into the corresponding list item. If a next steps section is empty for a task, leave the list item emtpy.
7. And that's it, check the rendering looks good and push to master.