Merge pull request #53 from MathewBiddle/part_guide

making participant guide for 2024

_config.yml

@@ -20,15 +20,15 @@ header_pages:
   - agenda.md
 #  - topics.md
   - videos-slides.md
-  - resources.md
+#  - _resources.md
   - about.md
 
 # Open and close the registration form
 #   soon = Registration has not yet opened
 #   open = Registration form is open
 #   closed = Registration form is now closed
 registration_status_2022: closed
-registration_status_2024: open
+registration_status_2024: closed
 
 # Remove ".html" from default permalinks
 permalink: pretty
@@ -50,6 +50,9 @@ collections:
   abouts:
     output: true
     permalink: :year/:title:output_ext
+  resources:
+    output: true
+    permalink: :year/:title:output_ext
 
 future: true
 # Social media links

_includes/header.html

@@ -39,6 +39,11 @@
                 <span>{{ page.year }} About</span>
             </a>
 
+            <a class="page-link {% if page.url == node.url %}active{% endif %}" href="{{ site.baseurl }}/{{ page.year }}/participant-guide">
+                <i class="bi bi-globe2"></i>
+                <span>{{ page.year }} Participant Guide</span>
+            </a>
+
         </div>
       </nav>
   </div>

resources/participant-guide.md → _resources/2022-04-25-participant-guide.md

@@ -1,6 +1,7 @@
 ---
 title: Participant guide
 layout: resource
+year: 2022
 ---
 
 <div class="lead" markdown="1">

_resources/2024-05-01-participant-guide.md

@@ -0,0 +1,92 @@
+---
+title: Participant guide
+layout: page
+year: 2024
+---
+
+<div class="lead" markdown="1">
+# Welcome to the IOOS Code Sprint
+
+**We're glad you're here!**
+
+This guide explains how the code sprint is being organized, from how we will be
+communicating, what activities we envisage you will undertake, how we suggest
+you access data and store your code/outputs.
+</div>
+
+## Overview
+{:.no_toc}
+
+In this guide we'll cover:
+
+* Table of contents
+{:toc}
+
+<div class="aside" markdown="1">
+We recommend that when you first sit down with your group, someone volunteers to serve as the **chair** for your topic.
+This person should be responsible for:
+* Ensuring that the group works to the suggested agenda.
+* The group is ready to present their work during their presentation slot(s). 
+* The code/outputs are well organized.
+This is an excellent way of getting some team management experience and so we emphasize that this person does not need to be somebody who is already leading a topic. 
+* Updating the `#code-sprint-2024` channel every 45 minutes with a short update on your track's activity. Make sure to `#tag` your topic's channel. 
+
+</div>
+
+## How our event is structured
+The event is a hybrid format with attendees both in-person at The Wharf, and vitrual connecting through Zoom and Slack. 
+
+### For virtual attendees
+Before the week of the Code Sprint, you will receive a link to a Google Calendar for the Code Sprint events. Below is a description of how each of those events relates to the Code Sprint as a whole.
+
+**MAIN ROOM** - This will be the virtual connection to the parts of the agenda that are for the entire Code Sprint audience (Introductions, Daily kickoff, and Daily recap).  
+
+**[track]** - There are individual Zoom breakout rooms for each of the Tracks listed [here](https://github.com/ioos/ioos-code-sprint/blob/main/2024/track-list.md). This is where participants will be spending the majority of their time. These spaces will be available for you to connect to during the break group portions of the event. You can enter and exit the sprint track rooms as you wish. 
+
+### For in-peron attendees
+
+* Make sure the room you are in has a connection to the appropriate Zoom breakout room for virtual attendees.
+* Make an announcement on the `#code-sprint-2024` channel, identifying the topic to be worked on and the Zoom breakout room information.
+* Check the [agenda]({{ site.baseurl }}/2024/agenda) or the `#code-sprint-2024` channel on Slack for more detailed information.
+
+## How we are communicating
+
+We are using:
+* **Zoom** for the talks and breakout groups. All participants will be invited to all the meetings so virtual attendees can easily move between them as needed. 
+* **Slack** for text-based chat, sharing of ideas, announcements and technical support (we have a channel for each project group, plus the main #code-sprint-2024 channel. 
+* **[Resources]({{ site.baseurl }}{% link resources.md %})** will be where any slides, or resources can be linked for reference during the event of afterwards (this page will live on!). 
+* **[Topic]({{ site.baseurl }}{% link topics.md %})** pages will fill out as the sprint progresses. Anyone can submit a change to these pages. 
+
+## How we are storing code, data and outputs
+
+Each project should have:
+
+* A **GitHub repository**, which you can use to share you code and the outcomes
+  of your work
+
+<div class="lead" markdown="1">
+We ask that by the end of the code sprint:
+
+1. Your project's GitHub repository has a **README** file (or GitHub issue), identifying what work
+   you did, how far you got and what the next steps required are
+2. You identify one (or more) **key figures/outcomes** that could be showcased at the 
+   Annual DMAC meeting.
+</div>
+
+## Where to go for help
+
+<div class="aside" markdown="1">
+The best way to contact us during the code sprint is to use the channel `#code-sprint-2024` on Slack.
+</div>
+
+### A note on bandwidth at the event
+
+For those attending in-person, at The Wharf, we will be using the wifi network provided. If you need high bandwidth to download large amounts of data for your project we recommend using cloud services, preload on local machine, or bring usb sticks. If you have special circumstances or questions, please post your requirements to the `#code-sprint-2024` Slack channel and we can see how we can accomodate your needs.
+
+## Feedback
+
+We really appreciate your feedback on this code sprint, in the hope that we can improve future events for yourself and others. Near the end of the code sprint we will send round a link to a feedback form for you to complete.
+
+## Questions?
+
+Email (or Slack) Matt Biddle ([email protected])!

resources.md

@@ -1,5 +1,5 @@
 ---
-title: Code Sprint resources
+title: Code Sprint _resources
 menu_title: Resources
 menu_icon: journal-code
 ---
@@ -8,7 +8,7 @@ menu_icon: journal-code
 <li class="resource-block" markdown="1">
 
 ## Getting set up
-#### [Participant guide]({{ site.baseurl }}{% link resources/participant-guide.md %}) - a guide that explains how the code sprint is being organised
+#### [Participant guide]({{ site.baseurl }}/resources/2022/participant-guide.html) - a guide that explains how the code sprint is being organised
 </li>
 
 <li class="resource-block" markdown="1">
@@ -20,7 +20,7 @@ menu_icon: journal-code
 <li class="resource-block" markdown="1">
 
 ## Help for organisers
-#### [Event checklist]({{ site.baseurl }}{% link resources/event-checklist.md %}) – a checklist for activities required in the run-up to a hackathon event
+#### [Event checklist]({{ site.baseurl }}//resources/2022/event-checklist.html) – a checklist for activities required in the run-up to a hackathon event
 
 An at-a-glace guide to the key activities required when organising a
 hackathon, including links to relevant resources and templates.
@@ -29,7 +29,6 @@ hackathon, including links to relevant resources and templates.
 <li class="resource-block" markdown="1">
 
 ## Useful templates
-#### [Templates]({{ site.baseurl }}{% link resources/templates.md %}) - useful forms, emails and resources for organisers
 
 
 </li>