CodeYourFuture / curriculum

The CYF Curriculum
https://curriculum.codeyourfuture.io
Other
34 stars 42 forks source link

Feature: Define and register Archetypes module #425

Closed SallyMcGrath closed 9 months ago

SallyMcGrath commented 11 months ago

Which module(s) and week(s) does this change affect? Module(s): n/a Week(s): n/a

What is the work that needs to be done?

I have not been using archetypes but without domain knowledge others will need them. This feature has two parts:

1 shell scripting

Move the markdown definitions from inside create_module.sh to a series of archetypes Issue hugo new post or similar instead of echo-ing the text directly inside the script

2 hugo tooling

Publish the archetypes as a module -- open question -- here or in another repo Make sure all the possible options are in the archetype, just by opening a draft PR and getting opinions/feedback is fine

Why is this work important to do?

  1. When someone from another school wants to create and contribute content they will need to generate a suitable markdown document.
  2. If we put a decap CMS on that requires an archetype, see https://github.com/CodeYourFuture/CYF-PD/blob/main/archetypes/default.md?plain=1 for an example

Additional context

Who might need to know about this change?

SallyMcGrath commented 10 months ago

scaled this back https://github.com/CodeYourFuture/curriculum-labs