Skip to content

Commit 65ea215

Browse files
SallyMcGrathSallyMcGrath
committed
curriculum site 1.0
loads of stuff to polish - just looking at the structure now the blocks are just example content, not completed
1 parent e0699bf commit 65ea215

File tree

422 files changed

+6927
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

422 files changed

+6927
-1
lines changed

Diff for: ‎.github/FUNDING.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
github: CodeYourFuture
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

Diff for: ‎.github/ISSUE_TEMPLATE/bug-report.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
12+
<!-- A clear and concise description of what the bug is. -->
13+
14+
**What is wrong with this content?**
15+
16+
**How could this be fixed?**
17+
18+
**Link to content**
19+
20+
**Additional context**
21+
22+
**Who else might need to know about this?**

Diff for: ‎.github/ISSUE_TEMPLATE/change-request.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Change Request
3+
about: Suggest a change to the syllabus
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Which module(s) and week(s) does this change affect?**
11+
Module(s):
12+
Week(s):
13+
14+
**What is the work that needs to be done?**
15+
16+
<!-- Please try to be as descriptive as possible -->
17+
18+
**Why is this work important to do?**
19+
20+
<!-- Please try to be as descriptive as possible -->
21+
22+
**Additional context**
23+
24+
**Who might need to know about this change?**
25+
26+
<!-- Please tag people here -->

Diff for: ‎.github/ISSUE_TEMPLATE/discussion.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Start Discussion
3+
about: Start a discussion around a topic to gather opinions
4+
title: ''
5+
labels: discussion
6+
assignees: ''
7+
8+
---
9+
10+
**What is the hypothesis?**
11+
12+
**Why is this important?**
13+
14+
**Supporting Resources**

Diff for: ‎.github/ISSUE_TEMPLATE/workshop-request.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Workshop Request
3+
about: Request a workshop from a CodeYourFuture volunteer
4+
title: "[Workshop]"
5+
labels: Workshop
6+
assignees: ""
7+
---
8+
9+
# Workshop Request
10+
11+
## What is the title of your workshop
12+
13+
<!--- What your answer here. -->
14+
15+
## What are the key topics that will be covered in the workshop?
16+
17+
<!--- What your answer here. Be as precise as possible -->
18+
19+
## What knowledge does the trainee need before starting?
20+
21+
<!--- What your answer here. Be as precise as possible -->
22+
23+
## What are the topics that will **not** be covered in the workshop?
24+
25+
<!--- What your answer here. Be as precise as possible -->
26+
27+
## Any other notes?
28+
29+
<!--- What your answer here. Be as precise as possible -->
30+
31+
## Completion
32+
33+
When completed the lesson plan, slides and exercises should be added to the Workshop section of the Syllabus

Diff for: ‎.github/pull_request_template.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## What does this change?
2+
3+
Module:
4+
Week(s):
5+
6+
## Checklist
7+
8+
- [ ] I have read the [contributing guidelines](CONTRIBUTING.MD)
9+
- [ ] I have checked my spelling and grammar with an [automated tool](https://www.grammarly.com/grammar-check)
10+
- [ ] 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
11+
- [ ] I have run my code to check it works
12+
- [ ] My changes follow our [Style Guide](https://curriculum.codeyourfuture.io/guides/code-style-guide)
13+
14+
## Description
15+
16+
<!-- Add a description of what your PR changes here -->
17+
18+
## Who needs to know about this?
19+
20+
<!-- Tag anyone who might want to be notified about this PR -->
21+
22+
## Rendered Pages
23+
24+
<!-- Leave this area and below blank. A github bot will render your changed github files for you here. -->

Diff for: ‎.github/workflows/lighthouse.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Lighthouse CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
lighthouse:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v2
15+
16+
- name: Setup Node.js
17+
uses: actions/setup-node@v2
18+
with:
19+
node-version: 14
20+
21+
- name: Install Lighthouse CI
22+
run: npm ci
23+
24+
- name: Run Lighthouse CI
25+
run: |
26+
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")"
27+
echo "DEPLOY_URL=$DEPLOY_URL" >> $GITHUB_ENV
28+
npx lhci autorun --collect.url=$DEPLOY_URL --upload.target=temporary-public-storage
29+
env:
30+
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
31+
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}

Diff for: ‎.github/workflows/main.yml

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: documentation
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
push:
7+
branches: [main]
8+
9+
jobs:
10+
checks:
11+
if: github.event_name != 'push'
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v3
15+
- uses: actions/setup-node@v3
16+
with:
17+
node-version: "16.x"
18+
cache: "npm"
19+
- name: Test Build
20+
run: |
21+
npm ci
22+
npm run build
23+
gh-release:
24+
if: github.event_name != 'pull_request'
25+
runs-on: ubuntu-latest
26+
steps:
27+
- uses: actions/checkout@v3
28+
- uses: actions/setup-node@v3
29+
with:
30+
node-version: "16.x"
31+
cache: "npm"
32+
- name: Add key to allow access to repository
33+
env:
34+
SSH_AUTH_SOCK: /tmp/ssh_agent.sock
35+
run: |
36+
mkdir -p ~/.ssh
37+
ssh-keyscan github.com >> ~/.ssh/known_hosts
38+
echo "${{ secrets.GH_PAGES_DEPLOY }}" > ~/.ssh/id_rsa
39+
chmod 600 ~/.ssh/id_rsa
40+
cat <<EOT >> ~/.ssh/config
41+
Host github.com
42+
HostName github.com
43+
IdentityFile ~/.ssh/id_rsa
44+
EOT
45+
- name: Release to GitHub Pages
46+
env:
47+
USE_SSH: true
48+
GIT_USER: git
49+
run: |
50+
git config --global user.email "[email protected]"
51+
git config --global user.name "gh-actions"
52+
npm ci
53+
npx docusaurus deploy

Diff for: ‎.gitignore

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
**/public
7+
**/resources
8+
9+
# Generated files
10+
.docusaurus
11+
.cache-loader
12+
13+
# Misc
14+
.DS_Store
15+
.env.local
16+
.env.development.local
17+
.env.test.local
18+
.env.production.local
19+
.vscode
20+
/.vscode
21+
22+
npm-debug.log*
23+
yarn-debug.log*
24+
yarn-error.log*
25+
26+
# CI uses package-lock.json, don't allow yarn.lock
27+
yarn.lock

Diff for: ‎.prettierrc

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"overrides": [
3+
{
4+
"files": ["*.html"],
5+
"options": {
6+
"parser": "go-template",
7+
"goTemplateBracketSpacing": true,
8+
"bracketSameLine": true
9+
}
10+
}
11+
]
12+
}

Diff for: ‎CONTRIBUTING.md

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# Contribution Guide
2+
3+
## Welcome to the CYF Curriculum
4+
5+
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_.
6+
7+
This curriculum compiles narratives and activities developed by hundreds of people all over the world. You are invited to join us.
8+
9+
https://codeyourfuture.io/
10+
11+
## Who runs this?
12+
13+
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.
14+
15+
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!
16+
17+
## What content?
18+
19+
### Our content is:
20+
21+
- practical
22+
- written in simple English at a maximum of CEFR B2
23+
- free
24+
25+
### Our content is not:
26+
27+
- a textbook
28+
- a reference manual
29+
- a collection of tutorials
30+
31+
## How to contribute
32+
33+
### Propose a new narrative or activity
34+
35+
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.
36+
37+
1. Develop your narrative or activity in a CYF repo.
38+
2. If you're recording a video, upload it to YouTube and make it public.
39+
3. Use your material and iterate on it with trainees.
40+
4. When you're ready to propose adoption, open a PR to this repo, and choose the adoption PR template.
41+
5. The Global Tech Ed team will consider your proposal and give you feedback.
42+
43+
**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.)
44+
45+
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_.
46+
47+
_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.
48+
49+
## Pedagogy
50+
51+
We use the [Teach Tech Together](https://teachtogether.tech/) pedagogical framework.
52+
53+
---
54+
55+
<details>
56+
<summary>https://github.com/CodeYourFuture/CYF-Coursework-Template</summary>
57+
58+
# COURSEWORK NAME
59+
60+
Replace this readme with the requirements for your coursework
61+
62+
## Learning Objectives
63+
64+
```objectives
65+
- [ ] Use the [Teach Tech Together](https://teachtogether.tech/en/index.html#s:process-objectives) guide to construct your objectives
66+
- [ ] Limit the objectives to 3-5 items
67+
- [ ] Write objectives you can measure
68+
```
69+
70+
## Requirements
71+
72+
Explain the requirements of the coursework. You might want to talk about goals here.
73+
You might want to use formal specifications like Given/When/Then. It's ok for requirements to be in different formats.
74+
We want trainees to learn to interpret requirements in many settings and expressions.
75+
76+
## Acceptance Criteria
77+
78+
- [ ] I have provided clear success criteria
79+
- [ ] These might be related to the objectives and the requirements
80+
- [ ] I have given some simple, clear ways for trainees to evaluate their work
81+
- [ ] I have run Lighthouse and my Accessibility score is 100
82+
83+
</details>
84+
85+
---
86+
87+
## How to join CYF Tech Ed
88+
89+
[Volunteer with CYF](https://codeyourfuture.io/volunteers/)
90+
91+
## Bugs
92+
93+
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!
94+
95+
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]().
96+
97+
(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.)

0 commit comments

Comments
 (0)