forked from CodeYourFuture/curriculum
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
loads of stuff to polish - just looking at the structure now the blocks are just example content, not completed
- Loading branch information
1 parent
e0699bf
commit 65ea215
Showing
422 changed files
with
6,927 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# These are supported funding model platforms | ||
|
||
github: CodeYourFuture | ||
patreon: # Replace with a single Patreon username | ||
open_collective: # Replace with a single Open Collective username | ||
ko_fi: # Replace with a single Ko-fi username | ||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
liberapay: # Replace with a single Liberapay username | ||
issuehunt: # Replace with a single IssueHunt username | ||
otechie: # Replace with a single Otechie username | ||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
|
||
<!-- A clear and concise description of what the bug is. --> | ||
|
||
**What is wrong with this content?** | ||
|
||
**How could this be fixed?** | ||
|
||
**Link to content** | ||
|
||
**Additional context** | ||
|
||
**Who else might need to know about this?** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
name: Change Request | ||
about: Suggest a change to the syllabus | ||
title: '' | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Which module(s) and week(s) does this change affect?** | ||
Module(s): | ||
Week(s): | ||
|
||
**What is the work that needs to be done?** | ||
|
||
<!-- Please try to be as descriptive as possible --> | ||
|
||
**Why is this work important to do?** | ||
|
||
<!-- Please try to be as descriptive as possible --> | ||
|
||
**Additional context** | ||
|
||
**Who might need to know about this change?** | ||
|
||
<!-- Please tag people here --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
name: Start Discussion | ||
about: Start a discussion around a topic to gather opinions | ||
title: '' | ||
labels: discussion | ||
assignees: '' | ||
|
||
--- | ||
|
||
**What is the hypothesis?** | ||
|
||
**Why is this important?** | ||
|
||
**Supporting Resources** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
name: Workshop Request | ||
about: Request a workshop from a CodeYourFuture volunteer | ||
title: "[Workshop]" | ||
labels: Workshop | ||
assignees: "" | ||
--- | ||
|
||
# Workshop Request | ||
|
||
## What is the title of your workshop | ||
|
||
<!--- What your answer here. --> | ||
|
||
## What are the key topics that will be covered in the workshop? | ||
|
||
<!--- What your answer here. Be as precise as possible --> | ||
|
||
## What knowledge does the trainee need before starting? | ||
|
||
<!--- What your answer here. Be as precise as possible --> | ||
|
||
## What are the topics that will **not** be covered in the workshop? | ||
|
||
<!--- What your answer here. Be as precise as possible --> | ||
|
||
## Any other notes? | ||
|
||
<!--- What your answer here. Be as precise as possible --> | ||
|
||
## Completion | ||
|
||
When completed the lesson plan, slides and exercises should be added to the Workshop section of the Syllabus |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
## What does this change? | ||
|
||
Module: | ||
Week(s): | ||
|
||
## Checklist | ||
|
||
- [ ] I have read the [contributing guidelines](CONTRIBUTING.MD) | ||
- [ ] I have checked my spelling and grammar with an [automated tool](https://www.grammarly.com/grammar-check) | ||
- [ ] I have previewed my changes to check the [markdown renders](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) as I intend | ||
- [ ] I have run my code to check it works | ||
- [ ] My changes follow our [Style Guide](https://curriculum.codeyourfuture.io/guides/code-style-guide) | ||
|
||
## Description | ||
|
||
<!-- Add a description of what your PR changes here --> | ||
|
||
## Who needs to know about this? | ||
|
||
<!-- Tag anyone who might want to be notified about this PR --> | ||
|
||
## Rendered Pages | ||
|
||
<!-- Leave this area and below blank. A github bot will render your changed github files for you here. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
name: Lighthouse CI | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
lighthouse: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v2 | ||
|
||
- name: Setup Node.js | ||
uses: actions/setup-node@v2 | ||
with: | ||
node-version: 14 | ||
|
||
- name: Install Lighthouse CI | ||
run: npm ci | ||
|
||
- name: Run Lighthouse CI | ||
run: | | ||
export DEPLOY_URL="$(curl -s -H "Authorization: Bearer $NETLIFY_AUTH_TOKEN" https://api.netlify.com/api/v1/sites/$NETLIFY_SITE_ID/deploys | jq -r ".[0].deploy_ssl_url")" | ||
echo "DEPLOY_URL=$DEPLOY_URL" >> $GITHUB_ENV | ||
npx lhci autorun --collect.url=$DEPLOY_URL --upload.target=temporary-public-storage | ||
env: | ||
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} | ||
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: documentation | ||
|
||
on: | ||
pull_request: | ||
branches: [main] | ||
push: | ||
branches: [main] | ||
|
||
jobs: | ||
checks: | ||
if: github.event_name != 'push' | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: actions/setup-node@v3 | ||
with: | ||
node-version: "16.x" | ||
cache: "npm" | ||
- name: Test Build | ||
run: | | ||
npm ci | ||
npm run build | ||
gh-release: | ||
if: github.event_name != 'pull_request' | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: actions/setup-node@v3 | ||
with: | ||
node-version: "16.x" | ||
cache: "npm" | ||
- name: Add key to allow access to repository | ||
env: | ||
SSH_AUTH_SOCK: /tmp/ssh_agent.sock | ||
run: | | ||
mkdir -p ~/.ssh | ||
ssh-keyscan github.com >> ~/.ssh/known_hosts | ||
echo "${{ secrets.GH_PAGES_DEPLOY }}" > ~/.ssh/id_rsa | ||
chmod 600 ~/.ssh/id_rsa | ||
cat <<EOT >> ~/.ssh/config | ||
Host github.com | ||
HostName github.com | ||
IdentityFile ~/.ssh/id_rsa | ||
EOT | ||
- name: Release to GitHub Pages | ||
env: | ||
USE_SSH: true | ||
GIT_USER: git | ||
run: | | ||
git config --global user.email "[email protected]" | ||
git config --global user.name "gh-actions" | ||
npm ci | ||
npx docusaurus deploy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Dependencies | ||
/node_modules | ||
|
||
# Production | ||
/build | ||
**/public | ||
**/resources | ||
|
||
# Generated files | ||
.docusaurus | ||
.cache-loader | ||
|
||
# Misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
.vscode | ||
/.vscode | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
# CI uses package-lock.json, don't allow yarn.lock | ||
yarn.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{ | ||
"overrides": [ | ||
{ | ||
"files": ["*.html"], | ||
"options": { | ||
"parser": "go-template", | ||
"goTemplateBracketSpacing": true, | ||
"bracketSameLine": true | ||
} | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
# Contribution Guide | ||
|
||
## Welcome to the CYF Curriculum | ||
|
||
We are a volunteer-led community of tech professionals, and we teach people to code for free. We are majority-minority, we welcome everyone, and we welcome _you_. | ||
|
||
This curriculum compiles narratives and activities developed by hundreds of people all over the world. You are invited to join us. | ||
|
||
https://codeyourfuture.io/ | ||
|
||
## Who runs this? | ||
|
||
The Global Syllabus Team is a group of long term CYF volunteers who are responsible for the overall direction of the curriculum. All Tech Ed volunteers can, and do, develop content for the curriculum, but the Global Syllabus Team decide the strategy and accept new content into the core. | ||
|
||
This team is led by the Director of Education, currently [Sally McGrath](https://github.com/SallyMcGrath). We meet every two weeks to discuss the curriculum and make decisions. The agenda is posted in the CYF Slack channel #cyf-syllabus-tech and the minutes are posted on this website. If you'd like to come and talk to us, please do! | ||
|
||
## What content? | ||
|
||
### Our content is: | ||
|
||
- practical | ||
- written in simple English at a maximum of CEFR B2 | ||
- free | ||
|
||
### Our content is not: | ||
|
||
- a textbook | ||
- a reference manual | ||
- a collection of tutorials | ||
|
||
## How to contribute | ||
|
||
### Propose a new narrative or activity | ||
|
||
We adopt _tested_ content into the main curriculum, so develop and try out your material first! Come to class, try it, and get feedback from the community. Come talk in #cyf-syllabus-tech on Slack and iterate on your session. | ||
|
||
1. Develop your narrative or activity in a CYF repo. | ||
2. If you're recording a video, upload it to YouTube and make it public. | ||
3. Use your material and iterate on it with trainees. | ||
4. When you're ready to propose adoption, open a PR to this repo, and choose the adoption PR template. | ||
5. The Global Tech Ed team will consider your proposal and give you feedback. | ||
|
||
**We like to experiment.** If you have an idea, try it out and let us know how it goes! Keep your experiments small and test them early. (If you want to try something big, like a new module, come talk to us first.) | ||
|
||
Our curriculum threads a coherent line through all of this activity, so whatever worlds we explore, we can all come back here and find out _what_ to do _next_. | ||
|
||
_Most_ content we develop and use with classes will not be adopted into the core curriculum -- that's ok! We want to be free to experiment. | ||
|
||
## Pedagogy | ||
|
||
We use the [Teach Tech Together](https://teachtogether.tech/) pedagogical framework. | ||
|
||
--- | ||
|
||
<details> | ||
<summary>https://github.com/CodeYourFuture/CYF-Coursework-Template</summary> | ||
|
||
# COURSEWORK NAME | ||
|
||
Replace this readme with the requirements for your coursework | ||
|
||
## Learning Objectives | ||
|
||
```objectives | ||
- [ ] Use the [Teach Tech Together](https://teachtogether.tech/en/index.html#s:process-objectives) guide to construct your objectives | ||
- [ ] Limit the objectives to 3-5 items | ||
- [ ] Write objectives you can measure | ||
``` | ||
|
||
## Requirements | ||
|
||
Explain the requirements of the coursework. You might want to talk about goals here. | ||
You might want to use formal specifications like Given/When/Then. It's ok for requirements to be in different formats. | ||
We want trainees to learn to interpret requirements in many settings and expressions. | ||
|
||
## Acceptance Criteria | ||
|
||
- [ ] I have provided clear success criteria | ||
- [ ] These might be related to the objectives and the requirements | ||
- [ ] I have given some simple, clear ways for trainees to evaluate their work | ||
- [ ] I have run Lighthouse and my Accessibility score is 100 | ||
|
||
</details> | ||
|
||
--- | ||
|
||
## How to join CYF Tech Ed | ||
|
||
[Volunteer with CYF](https://codeyourfuture.io/volunteers/) | ||
|
||
## Bugs | ||
|
||
If you spot a bug, please let us know by [creating an issue]() or opening a PR with the fix. Bug fixes are super welcome! | ||
|
||
As this front end composes many different repos, please open an issue in the repo where you found the bug. If you're not sure, open an issue in this [main repo](). | ||
|
||
(If the content is pulled from another repo, there's a link next to the heading -- follow that link to the source repo and open an issue there.) |
Oops, something went wrong.