Merge branch 'main' into dwh-mentored-pair-programming

common-docs/hugo.toml

@@ -44,7 +44,7 @@ title = "The longed for documentation"
         url = "https://codeyourfuture.io/donate"    
 
 [params]
-googleFonts="https://fonts.googleapis.com/css2?family=Oswald:wght@400;700&display=swap"
+googleFonts="https://fonts.googleapis.com/css2?family=Noto+Color+Emoji&family=Oswald:wght@400;700&display=swap"
 description = "A free and open source technical curriculum platform."
 main_website = "https://curriculum.codeyourfuture.io/"
 main_org_name = "Code Your Future"

common-theme/assets/styles/02-variables/fonts.scss

@@ -4,6 +4,6 @@
     "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue",
     sans-serif;
   --theme-font--system: 100 100%/2 "Monaco", "Menlo", "Space Grotesk", monospace;
-  --theme-font--emoji: Apple Color Emoji, "Segoe UI Emoji", "Noto Color Emoji",
-    "EmojiOne Color", "Twemoji Mozilla";
+  --theme-font--emoji: "Fluent UI Emoji", Apple Color Emoji, "Noto Color Emoji",
+    "Segoe UI Emoji", "EmojiOne Color", "Twemoji Mozilla";
 }

org-cyf-itd/content/blocks/how-itd-works/accessing-the-dashboard/index.md

@@ -0,0 +1,22 @@
++++
+title="Accessing the Dashboard"
+author="Tony Beaumont"
+description="How to access the dashboard"
+time=15
++++
+
+## How to access the Dashboard
+
+These instructions come from **Step 4** in the `#cyf-intro-to-digital-course` canvas ([https://codeyourfuture.slack.com/canvas/C01332PNRTN](https://codeyourfuture.slack.com/canvas/C01332PNRTN) so please refer to that first as it contains links to the instructions your should follow to access the dashboard. The information below is just designed to summarise those instructions..
+
+1. Volunteers need to access the Dashboard [https://dashboard.codeyourfuture.io/](https://dashboard.codeyourfuture.io/)
+1. Sign in using GitHub.
+1. If you are just registering as a new volunteer you should complete the application form.
+1. If you have already registered, click the link at the top which says
+   ```console
+   Important: If you already completed this form in some point please click here.
+   ```
+   This takes you to a page where you enter your email address and you will then get sent an email to confirm your login and thereafter you will be able to access the dashboard directly. If you have problems, post a question into the slack channel `#cyf-intro-to-digital-course`<br/>
+1. Once you are in, the home screen of the dashboard looks like this:<br/>
+   ![the dashboard home screen](dashboardHome.png)<br/>
+   The menu at the top has links to the home page and the ITD programme. There will be other programs linked here as and when they start and have applicants on them.

org-cyf-itd/content/blocks/how-itd-works/know-learn-need-do/index.md

@@ -0,0 +1,37 @@
++++
+title="What you know, what you will learn"
+author="Tony Beaumont"
+time=10
++++
+
+### As a volunteer you should:
+
+- be able to spend some time on the tasks that need volunteers to complete so that CYF can function. Volunteers enable CYF to achieve its goals.
+- be digitally literate
+- Your feedback to applicants will be guided by one or both of the following
+  - technical expertise in some of the full stack development technologies including HTML, CSS, Javascript, React, SQL (Postgres)
+  - expertise in personal skills to guide applicants in their personal development, for example in communication, presentation, time management, work-life balance, etc.
+
+### What you'll learn
+
+- How to register (if you are a new volunteer)
+- How to access the dashboard
+- Where to find the syllabus
+- How to give helpful feedback.
+
+### What you'll need
+
+You will need a computer or tablet with this software installed:
+
+- Slack
+- A web browser
+
+CYF generally uses (Ubuntu) Linux rather than Windows or Macs. If you are trying to complete tasks that the applicants will do, instructions generally assume a Linux environment, so some experience of Linux would be helpful.
+
+### What you'll do
+
+On the following pages we will take you through all the necessary information on volunteering with ITD guide your feedback to applicants.
+
+- Access the Syllabus
+- Access the dashboard
+- Find applicant submissions and give feedback

org-cyf-itd/content/blocks/how-itd-works/reviewing/index.md

@@ -0,0 +1,13 @@
++++
+title="Reviewing"
+author="Tony Beaumont"
+time=10
++++
+
+> Reviewing work submitted by the applicants is a core task for volunteers.
+
+## Important
+
+Reviewing work submitted by the applicants is a core task for volunteers. You should prioritise reviewing submitted work when you have free time available. We will also have online sessions on Saturdays for ITD so please check in slack to find the details of those. The links should be posted into the channel and on the global channel.
+
+The Slack channel `#cyf-intro-to-digital-course` is for volunteers to discuss and ask questions, for example if you have questions about reviewing applicants work. This channel has a canvas containing important information [https://codeyourfuture.slack.com/canvas/C01332PNRTN](https://codeyourfuture.slack.com/canvas/C01332PNRTN). You **should read the canvas first**. This document contains additional information to help you find your way around as a volunteer.

org-cyf-itd/content/blocks/how-itd-works/useful-links/index.md

@@ -0,0 +1,36 @@
++++
+title="Useful links"
+author="Tony Beaumont"
+time=2
++++
+
+Here is a quick list of useful links (some are for applicants only, but it is helpful to know them if an applicant has a problem):
+
+**The ITD Syllabus:**  
+[https://cyf-itd.netlify.app/](https://cyf-itd.netlify.app/). It's right here.
+
+**ITD signup page (for applicants only):**  
+[https://codeyourfuture.io/itc/](https://codeyourfuture.io/itc/)
+
+**CYF Learning Platform (for applicants only):**  
+[https://course1.codeyourfuture.io/](https://course1.codeyourfuture.io/)
+
+**ITD Slack Channel:**  
+[https://codeyourfuture.slack.com/archives/C01332PNRTN](https://codeyourfuture.slack.com/archives/C01332PNRTN). Post into the slack channel if you have questions or problems.
+
+**ITD Canvas:**  
+[https://codeyourfuture.slack.com/canvas/C01332PNRTN](https://codeyourfuture.slack.com/canvas/C01332PNRTN). The canvas is the official CYF information about ITD. The canvas is attached to the ITD slack channel.
+
+**CYF Dashboard:**  
+ [https://dashboard.codeyourfuture.io/](https://dashboard.codeyourfuture.io/). Use the dashboard to view applicant progress.
+
+**Acceptance Criteria:** These are what you refer to when approving applicants work:
+
+- **Step 1**: [https://cyf-itd.netlify.app/steps/one/#acceptance-criteria](https://cyf-itd.netlify.app/steps/one/#acceptance-criteria)
+- **Step 2**: [https://cyf-itd.netlify.app/steps/two/#acceptance-criteria](https://cyf-itd.netlify.app/steps/two/#acceptance-criteria)
+- **Step 3**: [https://cyf-itd.netlify.app/steps/three/#acceptance-criteria](https://cyf-itd.netlify.app/steps/three/#acceptance-criteria)
+- **Step 4**: [https://cyf-itd.netlify.app/steps/four/#acceptance-criteria](https://cyf-itd.netlify.app/steps/four/#acceptance-criteria)
+- **Step 5**: [https://cyf-itd.netlify.app/steps/five/#acceptance-criteria](https://cyf-itd.netlify.app/steps/five/#acceptance-criteria)
+- **Step 6**: [https://cyf-itd.netlify.app/steps/six/#acceptance-criteria](https://cyf-itd.netlify.app/steps/six/#acceptance-criteria)
+
+## To be continued...

org-cyf-itd/content/blocks/how-itd-works/using-the-curriculum/index.md

@@ -0,0 +1,22 @@
++++
+title="Using the ITD Curriculum"
+author="Tony Beaumont"
+time=5
++++
+
+## Where to find the ITD Syllabus
+
+Before you can review the work submitted by applicants, you should familiarise yourself with the syllabus.
+
+This is the ITD syllabus.
+
+Applicants will work through the steps week by week. Each step contains instructions for the applicants to do complete a task which they should then submit. Volunteers can find these submissions on the dashboard and give feedback. There is a page which just contains the steps in order and that is here: [https://cyf-itd.netlify.app/steps/](https://cyf-itd.netlify.app/steps/). The Workshops will be organised by each region, and are designed to be face-to-face opportunities for applicants to ask questions and clarify their learning. Workshops will be advertised on Eventbrite and advertised in Slack.
+
+You will find that each step has a number of sub-components reachable via a menu which looks like this:<br/>
+![Components of a step are Instructions Acceptance Criteria Submission Help and Extensions](StepComponents.png).
+
+- The **Instructions** tell the applicant what to do. Volunteers should read this too so that you fully understand what is being asked of the volunteers in each step.
+- The **acceptance criteria** list everything the the applicant must do to successfully complete the step.
+- The **Submission** item tells the applicants what to submit. Volunteers can find these submissions in the dashboard.
+- The **Help** item tells the applicants how to get help.
+- The **Extensions** item gives a suggestion of other things a applicant can do in this step, but which don't have to be submitted.

org-cyf-itd/content/blocks/how-itd-works/using-the-dashboard/index.md

@@ -0,0 +1,53 @@
++++
+title="Using the CYF Dashboard"
+author="Tony Beaumont"
+time=15
++++
+
+## Using the dashboard: Seeing Applicants
+
+If you click on `See Applicants` in the **New Applicants** box, you will see a list of all the new applicants.<br/>
+![list of applicants](listOfApplicantsEdited.png)
+
+The blue Email button allows you to email applicants.
+In my screen I can download a CSV file containing the details of the applicants, but you may not have this option.
+
+You can use the `FILTERS` button to filter the view and see applicants in different areas, or limit the steps displayed. This screenshot shows some of the filter options:<br/>
+![The filter options](filters.png)
+
+## Using the dashboard: Reviewing work submitted by applicants
+
+If you click on `Review Steps` in the **Steps** box you will see a list of those applicants who have submitted work for one or more of the steps in the ITD syllabus. The view is a subset of all the applicants and looks similar:<br/>
+![list of applicants](listOfApplicantsEdited.png)<br/>
+_ You can see that `Applicant 1` has submitted work for Step 0 but it hasn't yet been approved. That is indicated by the `0` in the **Steps** column.  
+ _ `Applicant 2` has also submitted work for Step 0 and it has been approved because there is a tick AND a 0 in the **Steps** column.
+
+### How to view submissions
+
+- Click on the **name** of one of the applicants. You will see a menu appear like this one:<br/>
+  ![review options](reviewOptions.png).
+- If you click on **Steps** you will see what the applicant has submitted for the ITD steps. The example below shows the applicant has submitted work for three steps and you are looking at their submission link for STEP 1:
+  ![reviewing steps](reviewSteps.png)
+  Clicking the **Submitted** link will allow you to see their submitted work.
+
+### How to review a submission
+
+When reviewing a submission there are three things you can do:
+
+- **Communicating with the applicant**: If you click the **Comments button**<br/>
+  ![comment button](commentButton.png)<br/>
+  you can see comments left by other volunteers and add your own comments. You should post a comment back to the applicant if you have questions and you are not yet able to approve or reject the work. It is also good practice to post a comment when you reject a submission so the applicant can see why their work was rejected. You can comment after approving work to highlight what the applicant did well.
+- **Approving work**: When you are ready to approve the submitted work as meeting the acceptance criteria, click the **Approve button**. If you want to highlight work that you thought was good practice (or bad practice), leave a comment.<br/>
+  ![approve the work](reviewApprove.png)<br/>
+  Do not approve the work unless it meets the acceptance criteria.
+- **Rejecting work**: If you are rejecting the work as not meeting the acceptance criteria, click the **Reject button**<br/>
+  ![rejecting work](reviewReject.png)<br/>
+  You should leave comments to say why the work was rejected.
+- **Undoing a decision**: If you want to change your mind about approving or rejecting a piece of work, can click the Undo button as shown in this screenshot:<br/>
+  ![Undoing a decision](undoButton.png)<br/>
+  You should post a comment to the applicant to let them know why the decision was changed.
+
+## Using the dashboard: Workshops
+
+If you click the **Workshops** option under a applicant's name, you are able to record whether or not they attended a workshop and leave some text as context. Here is what the option looks like:<br/>
+![workshop records](workshops.png)

org-cyf-itd/content/blocks/how-itd-works/welcome/index.md

@@ -0,0 +1,15 @@
++++
+title="Welcome to new ITD Volunteers"
+author="Tony Beaumont"
+time=2
++++
+
+## Welcome from Tony
+
+The information you will find here is the information I found useful as a volunteer helping with the Introduction to Digital programme.
+
+### Introduction
+
+The Introduction to Digital course is known as ITD. You can find an overview of how ITD works here [https://cyf-itd.netlify.app/how-itd-works/](https://cyf-itd.netlify.app/how-itd-works/)
+
+The role of volunteers is to review submissions by applicants and respond with feedback. The submissions will be found on the Dashboard. See the side menu for the instructions on how to access the dashboard.

org-cyf-itd/content/blocks/how-itd-works/what-is-itd/index.md

@@ -0,0 +1,50 @@
++++
+title="How ITD works"
+description="A brief description of ITD"
+emoji="🗺️"
+time=5
++++
+
+### What is ITD
+
+When people [sign up to study](https://codeyourfuture.io/itc/) on our website, they are invited to begin our Intro To Digital (ITD) Course. This course opens for one month, then closes for one month, then reopens. It runs six times a year.
+
+Learners complete the course on our [Guided Learning platform](https://course1.codeyourfuture.io/) by completing a sequence of steps. Each step is explained clearly in B1 English. The text is reproduced on this site in the [Steps](./steps) section.
+
+These submissions are passed to our internal dashboard, where volunteers can track the progress of each person and help them move forward.
+
+Volunteers review the submissions and guide learners via:
+
+1. the comment threads on the dashboard
+1. our Slack workspace for ITD
+1. [drop-in sessions](./workshops) organised in-person or online by respective regional CYF teams
+1. calling and SMS messaging directly from the dashboard
+
+If you'd like to help, please [sign up as a volunteer](https://codeyourfuture.io/volunteer/).
+
+---
+
+### When does ITD run?
+
+{{<columns>}}
+
+### 📅 Open
+
+January
+March
+May
+July
+September
+November
+<--->
+
+### ⛔ Closed
+
+February
+April
+June
+August
+October
+December
+
+{{</columns>}}

org-cyf-itd/content/how-itd-works/index.md

@@ -1,50 +1,32 @@
 +++
-title="How ITD works"
-description="A brief description of ITD"
+title="Manual"
+description="How ITD works"
 menu=["syllabus", "start here"]
 emoji="🗺️"
+layout = 'prep'
+menu_level = ['module']
+[[blocks]]
+name="What is ITD"
+src="blocks/how-itd-works/what-is-itd"
+[[blocks]]
+name="Welcome new volunteers"
+src="blocks/how-itd-works/welcome"
+[[blocks]]
+name="Most important task"
+src="blocks/how-itd-works/reviewing"
+[[blocks]]
+name="Your role as a volunteer"
+src="blocks/how-itd-works/know-learn-need-do"
+[[blocks]]
+name="Using the curriculum"
+src="blocks/how-itd-works/using-the-curriculum"
+[[blocks]]
+name="How to access the dashboard"
+src="blocks/how-itd-works/accessing-the-dashboard"
+[[blocks]]
+name="How to use the dashboard"
+src="blocks/how-itd-works/using-the-dashboard"
+[[blocks]]
+name="Useful links"
+src="blocks/how-itd-works/useful-links"
 +++
-
-### What is ITD
-
-When people [sign up to study](https://codeyourfuture.io/itc/) on our website, they are invited to begin our Intro To Digital (ITD) Course. This course opens for one month, then closes for one month, then reopens. It runs six times a year.
-
-Learners complete the course on our [Guided Learning platform](https://course1.codeyourfuture.io/) by completing a sequence of steps. Each step is explained clearly in B1 English. The text is reproduced on this site in the [Steps](./steps) section.
-
-These submissions are passed to our internal dashboard, where volunteers can track the progress of each person and help them move forward.
-
-Volunteers review the submissions and guide learners via:
-
-1. the comment threads on the dashboard
-1. our Slack workspace for ITD
-1. [drop-in sessions](./workshops) organised in-person or online by respective regional CYF teams
-1. calling and SMS messaging directly from the dashboard
-
-If you'd like to help, please [sign up as a volunteer](https://codeyourfuture.io/volunteer/).
-
----
-
-### When does ITD run?
-
-{{<columns>}}
-
-### 📅 Open
-
-January
-March
-May
-July
-September
-November
-<--->
-
-### ⛔ Closed
-
-February
-April
-June
-August
-October
-December
-
-{{</columns>}}

org-cyf-itp/package.json

@@ -17,7 +17,7 @@
   "homepage": "https://github.com/CodeYourFuture/curriculum#readme",
   "dependencies": {
     "@netlify/functions": "^1.6.0",
-    "cookie": "^0.5.0",
+    "cookie": "^0.7.0",
     "dotenv": "^16.3.1",
     "googleapis": "^144.0.0",
     "joi": "^17.9.2",