archetypes for all required module views (#529)

* archetypes for all required module views

This moves page creation into Hugo archetypes. You can still run a create_module.sh to produce a module all at once. You can also generate any individual view from an archetype, and generate a block, with hugo new --kind

* Update archetypes/module.md

Co-authored-by: Daniel Wagner-Hall <[email protected]>

---------

Co-authored-by: Daniel Wagner-Hall <[email protected]>

archetypes/backlog.md

@@ -0,0 +1,13 @@
++++
+title = 'backlog'
+layout = 'backlog'
+emoji= '🥞'
+menu_level = ['sprint']
+weight = 2
+backlog= 'Module-Template'
+backlog_filter= 'Week 1'
++++
+
+This view lists all the issues for the current sprint. It is looking for a repo in your org named `Module-<module-name>` where it expects issues to live. You can edit this of course.
+
+Organise your issues with labels, like 'Week 1' or 'Week 2' to filter them into the right sprint. Pass the label into the `backlog_filter` in the front matter to filter the issues.

archetypes/blocks/index.md

@@ -0,0 +1,13 @@
++++
+title = '{{ replace .Name "-" " " | title }}'
+headless = true
+time = 30
+facilitation = false
+threads = ['to-be-assigned']
+emoji= '🧩'
+[objectives]
+    1='Use the Teach Tech Together guide to construct your objectives'
+    2='Limit the objectives to 3-5 items'
+    3='Write objectives you can measure'
++++
+

archetypes/day-plan.md

@@ -0,0 +1,45 @@
++++
+title = 'day-plan'
+layout = 'day-plan'
+emoji= '📅'
+menu_level = ['sprint']
+weight = 3
+[[blocks]]
+name="Energiser"
+src="blocks/energiser"
+[[blocks]]
+name="PD Placeholder to be replaced with PD link"
+src="blocks/pd-placeholder"
+[[blocks]]
+name="Morning break"
+src="blocks/morning-break"
+[[blocks]]
+name="Placeholder Workshop"
+src="https://github.com/CodeYourFuture/CYF-Workshops/tree/main/template"
+time="60"
+[[blocks]]
+name="Lunch"
+src="blocks/lunch"
+[[blocks]]
+name="Study Group 2"
+src="blocks/study-group"
+time="90"
+[[blocks]]
+name="Code Review"
+src="https://github.com/CodeYourFuture/Module-Template/pulls"
+time="0"
+[[blocks]]
+name="Afternoon break"
+src="blocks/afternoon-break"
+[[blocks]]
+name="Study Group 2"
+src="blocks/study-group"
+time="60"
+[[blocks]]
+name="Retro"
+src="blocks/retro"
++++
+
+This example day plan is a template for you to use. It is a good idea to have a consistent structure for your day plans so that everyone knows _what_ to do _when_. The day plan will create a schedule from the time (in minutes) stored on each block using the `time-stamper` web component. You can override this time by adding a `time` parameter in the front matter as shown above.
+
+This view doesn't expect any content in the `.Content` section; delete these instructions. If you want to add a description of the day, add it to a `.Description` parameter in the front matter.

archetypes/default.md

@@ -1,6 +1,5 @@
----
-title: "{{ replace .Name "-" " " | title }}"
-date: {{ .Date }}
-draft: true
----
++++
+title = '{{ replace .Name "-" " " | title }}'
++++
 
+This is just a single. You can use this to create an uncomplicated basic page. 

archetypes/module-prep.md

@@ -0,0 +1,32 @@
++++
+title = 'prep'
+description = 'This work must be done to prepare for this module'
+layout = 'prep'
+emoji= '🧑🏾‍💻'
+menu_level = ['module']
+weight = 1
+[[blocks]]
+name="Local"
+src="blocks/types/local"
+[[blocks]]
+name="Readme"
+src="https://github.com/CodeYourFuture/Module-Template"
+[[blocks]]
+name="Youtube video or playlist"
+src="https://www.youtube.com/watch?v=P1ww1IXRfTA"
+[[blocks]]
+name="Slide - an image with caption"
+caption="With caption please!"
+src="https://github.com/MaggieAppleton/maggieappleton.com-V2/blob/main/public/images/posts/programming-pictures/PicturesProgramming-26_vnlzye-1100.jpg"
+[[blocks]]
+name="PD syllabus website"
+src="https://cyf-pd.netlify.app/blocks/agreements/readme/"
+[[blocks]]
+name="Issue, just one"
+src="https://github.com/CodeYourFuture/Module-JS1/issues/8"
+[[blocks]]
+name="Pullreqs, list"
+src="https://github.com/CodeYourFuture/Module-JS1"
++++
+## Anything written in .Content needs an h2
+This example prep view has an example of each type of block so you can see how the blocks work. 

archetypes/module-success.md

@@ -0,0 +1,11 @@
++++
+title = 'success'
+layout = 'success'
+emoji= '✅'
+menu_level = ['module']
+weight = 4
++++
+
+This view compiles learning objectives from the day plan and prep view into a checkbox list to help trainees check in on their progress.
+
+You can initiate a module level success view as well and write in some overall outcomes or success criteria.

archetypes/module.md

@@ -0,0 +1,17 @@
++++
+title = '{{ replace .Name "-" " " | title }}'
+description = 'The plan for {{ replace .Name "-" " " | title }}'
+layout = 'module'
+emoji= '📚'
+menu = ['syllabus']
++++
+
+### Quickstart
+
+Generate a template module by running `./module_create.sh <module-name>` in the root of your website. This script produces a complete module structure with all the necessary files and folders from the Hugo archetypes stored in the `archetypes` folder. Create any single archetype by running `hugo new --kind $ARCHETYPE_NAME $PATH_TO_NEW_FILE`.
+
+The template module contains a prep view to express all your entry criteria and setup instructions for the module, 4 template sprints to plan the weekly work, a product folder to organise the module project, and a success view to express the exit criteria and handoff details.
+
+Edit this basic setup to suit your needs. The module folder is located at content/$MODULE_NAME and it creates pages matching the folder structure on your website.
+
+If you don't want this module to show up on the default menu, remove `menu = ['syllabus']` from the front matter. The pages will still be accessible via the URLs.

archetypes/prep.md

@@ -0,0 +1,32 @@
++++
+title = 'prep'
+description = 'Note the general topic'
+layout = 'prep'
+emoji= '🧑🏾‍💻'
+menu_level = ['sprint']
+weight = 1
+[[blocks]]
+name="Local"
+src="blocks/types/local"
+[[blocks]]
+name="Readme"
+src="https://github.com/CodeYourFuture/Module-Template"
+[[blocks]]
+name="Youtube video or playlist"
+src="https://www.youtube.com/watch?v=P1ww1IXRfTA"
+[[blocks]]
+name="Slide - an image with caption"
+caption="With caption please!"
+src="https://github.com/MaggieAppleton/maggieappleton.com-V2/blob/main/public/images/posts/programming-pictures/PicturesProgramming-26_vnlzye-1100.jpg"
+[[blocks]]
+name="PD syllabus website"
+src="https://cyf-pd.netlify.app/blocks/agreements/readme/"
+[[blocks]]
+name="Issue, just one"
+src="https://github.com/CodeYourFuture/Module-JS1/issues/8"
+[[blocks]]
+name="Pullreqs, list"
+src="https://github.com/CodeYourFuture/Module-JS1"
++++
+## Anything written in .Content needs an h2
+This example prep view has an example of each type of block so you can see how the blocks work. 

archetypes/product-backlog.md

@@ -0,0 +1,10 @@
++++
+title = 'backlog'
+layout = 'backlog'
+emoji= '🥞'
+menu_level = ['product']
+weight = 2
+backlog= 'React-Module-Project'
++++
+
+This view lists all the issues for the project. It is looking for a repo in your org named `React-Module-Project` where it expects issues to live. Wire in your actual project repo.

archetypes/product-prep.md

@@ -0,0 +1,20 @@
++++
+title = 'prep'
+description = 'Wire in your repo docs, example given'
+layout = 'prep'
+emoji= '🧑🏾‍💻'
+menu_level = ['product']
+weight = 1
+[[blocks]]
+name="Planning and organising your team"
+src="https://github.com/CodeYourFuture/React-Module-Project/tree/main/docs/plan/"
+[[blocks]]
+name="Building your product"
+src="https://github.com/CodeYourFuture/React-Module-Project/tree/main/docs/build/"
+[[blocks]]
+name="Test driven development"
+src="https://github.com/CodeYourFuture/React-Module-Project/tree/main/docs/test/"
+[[blocks]]
+name="Shipping your product"
+src="https://github.com/CodeYourFuture/React-Module-Project/tree/main/docs/ship/"
++++

archetypes/product.md

@@ -0,0 +1,11 @@
++++
+title = 'Product'
+description = 'The module project for {{ replace .Name "-" " " | title }}'
+layout = 'product'
+emoji= '🎁'
+menu_level = ['module']
++++
+
+Each module should have a module-length project that produces a tangible product. These products form a starting point for trainee portfolios, and are mandatory for progression. 
+
+The actual instructions are generally pulled from the project repo. 

archetypes/sprint.md

@@ -0,0 +1,9 @@
++++
+title = 'Sprint {{ replace .Name "-" " " | title }}'
+layout = 'sprint'
+emoji= '🎽'
+menu_level = ['module']
+weight = 2
++++
+
+This is an index to organise the views for a sprint block. If you want to remove this sprint from the menu, remove the `menu_level` parameter from the front matter. We don't use Hugo menus as Hugo doesn't like having duplicate items, but we want all our modules and sprints to have consistent, repeated (predictable) names. 

archetypes/success.md

@@ -0,0 +1,11 @@
++++
+title = 'success'
+layout = 'success'
+emoji= '✅'
+menu_level = ['sprint']
+weight = 4
++++
+
+This view compiles learning objectives from the day plan and prep view into a checkbox list to help trainees check in on their progress.
+
+You can initiate a module level success view as well and write in some overall outcomes or success criteria.