Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: replace labs again #540

Merged
merged 3 commits into from
Jan 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,17 @@ cd org-<your-org-name>
2. Initialise your new site as a hugo module, as only modules can import modules:

```zsh
hugo mod init github.com/CodeYourFuture/curriculum-labs/org-<your-org-name>
hugo mod init github.com/CodeYourFuture/curriculum/org-<your-org-name>
```

Then add the common theme and content modules as hugo modules to hugo.toml:

```toml
[module]
[[module.imports]]
path = "github.com/CodeYourFuture/curriculum-labs/common-theme"
path = "github.com/CodeYourFuture/curriculum/common-theme"
[[module.imports]]
path = "github.com/CodeYourFuture/curriculum-labs/common-content"
path = "github.com/CodeYourFuture/curriculum/common-content"
[[module.imports.mounts]]
source = "en"
target = "content"
Expand Down
49 changes: 0 additions & 49 deletions common-content/en/blocks/requirements/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,52 +31,3 @@ We're going to think about a few projects and discover some requirements. This i
{{<note type="tip" title="Remember" >}}
To make great software, we need to think about people, not just code.
{{</note>}}

### User Stories

We can discover requirements with something called 'User Stories'. The simplest user story looks like this:

> As a [type of user], I can [achieve some goal].

#### Imagine a coursework tracker

As trainees, you have coursework to do. Imagine a website which tracks how coursework is going for you all. Thinking about that website, some user stories could be:

- As a trainee, I can ask for help with a topic or task.
- As a mentor, I can see who needs extra support.
- As a trainee, I can see what coursework I need to complete and when.
- As a mentor, I can see what coursework has not been completed.

These each take the form "As [who], I can [what]". They don't say why yet.

{{<note type="activity" title="Exercise 10 Minutes" >}}
In groups of about 5.

Talk about why the "who" is useful. What would we be missing if we didn't think about the "Who"?

Now think about the "why" for each of the listed user stories. Why are they important?

{{</note>}}

> As a [who], I can [what] so that **[why]**

{{<note type="activity" title="Exercise 10 Minutes" >}}

Write some user stories for our coursework tracker on a Jamboard.

Think about the "who", "what", and "why" for each.

You can think of new "who"s (e.g. the people who write the coursework questions), and as many "what"s as you want - but make sure you remember the "why".
{{</note>}}

### Reflecting

{{<note type="glossary" title="Key Term" >}}
A user story is a short sentence stating some goal a user can expect to achieve when using the product we are implementing.
{{</note>}}

{{<note type="activity" title="10 Minutes" >}}
Why is thinking about user stories useful?

What's useful about thinking about the "who" and the "why"? What could go wrong if you don't think about them?
{{</note>}}
2 changes: 0 additions & 2 deletions common-content/en/blocks/user-stories/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ emoji= '🧩'
4='Translate requirements into high-level design outlines'
+++

{{< snippet "snippets/requirements.md" >}}

#### Imagine a coursework tracker

As trainees, you have coursework to do. Imagine a website which tracks how coursework is going for you all. Thinking about that website, some user stories could be:
Expand Down
2 changes: 0 additions & 2 deletions common-content/en/module/portfolio/requirements/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ emoji= '🧩'
2='Identify and explain the key user stories for your project'
+++

{{< snippet "snippets/requirements.md" >}}

In addition to [who] and [what], good user stories also include [why]

> As a [who], I can [what] so that **[why]**
Expand Down
3 changes: 3 additions & 0 deletions org-cyf/content/portfolio/sprints/1/day-plan/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ src="blocks/morning-break"
name="Gathering requirements"
src="blocks/requirements"
[[blocks]]
name="User stories"
src="blocks/user-stories"
[[blocks]]
name="Choosing a project"
src="module/portfolio/requirements"
[[blocks]]
Expand Down
4 changes: 2 additions & 2 deletions org-cyf/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ module github.com/CodeYourFuture/curriculum/org-cyf
go 1.21.3

require (
github.com/CodeYourFuture/curriculum-labs/common-content v0.0.0-20240114132825-493a89648721 // indirect
github.com/CodeYourFuture/curriculum-labs/common-theme v0.0.0-20240114132825-493a89648721 // indirect
github.com/CodeYourFuture/curriculum/common-content v0.0.0-20240121151641-e52b73ad527d // indirect
github.com/CodeYourFuture/curriculum/common-theme v0.0.0-20240121151641-e52b73ad527d // indirect
)
12 changes: 8 additions & 4 deletions org-cyf/go.sum
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
github.com/CodeYourFuture/curriculum-labs/common-content v0.0.0-20240114132825-493a89648721 h1:txnduLXqSKf3XHb/g74uhpGltb9FgyrdrMeC/Ce3vr0=
github.com/CodeYourFuture/curriculum-labs/common-content v0.0.0-20240114132825-493a89648721/go.mod h1:w5rIm9hJlHD+CYpQEVMWE/6WaE/EiLmYVs18Kw/iH0s=
github.com/CodeYourFuture/curriculum-labs/common-theme v0.0.0-20240114132825-493a89648721 h1:GSd+9AsvXJEjy2AvsP79YBpmMRhxydDhVvlbD5x5DKg=
github.com/CodeYourFuture/curriculum-labs/common-theme v0.0.0-20240114132825-493a89648721/go.mod h1:lWiQfXWr0Uc517tksx7D5p5ZoXo9bxRoJ0or+z9mRyk=
github.com/CodeYourFuture/curriculum/common-content v0.0.0-20240114132825-493a89648721 h1:txnduLXqSKf3XHb/g74uhpGltb9FgyrdrMeC/Ce3vr0=
github.com/CodeYourFuture/curriculum/common-content v0.0.0-20240114132825-493a89648721/go.mod h1:w5rIm9hJlHD+CYpQEVMWE/6WaE/EiLmYVs18Kw/iH0s=
github.com/CodeYourFuture/curriculum/common-content v0.0.0-20240121151641-e52b73ad527d h1:WfPdLoNvxOrNx3GB+DpYlpEH57v98h0KWXpidN+xdOo=
github.com/CodeYourFuture/curriculum/common-content v0.0.0-20240121151641-e52b73ad527d/go.mod h1:e3J+XphCBJJ8kf6S9ykVxNY1VKPWJoYuDFXEizlDpCI=
github.com/CodeYourFuture/curriculum/common-theme v0.0.0-20240114132825-493a89648721 h1:GSd+9AsvXJEjy2AvsP79YBpmMRhxydDhVvlbD5x5DKg=
github.com/CodeYourFuture/curriculum/common-theme v0.0.0-20240114132825-493a89648721/go.mod h1:lWiQfXWr0Uc517tksx7D5p5ZoXo9bxRoJ0or+z9mRyk=
github.com/CodeYourFuture/curriculum/common-theme v0.0.0-20240121151641-e52b73ad527d h1:ILE8f9gXLEPEyrJVBdFRVa0Uszf9OVdK4LjXZjCLUag=
github.com/CodeYourFuture/curriculum/common-theme v0.0.0-20240121151641-e52b73ad527d/go.mod h1:kzt+J4JYp5C3GD1dX0rf7vY5fsTUc6Drrn+7p7pjmLg=
4 changes: 2 additions & 2 deletions org-cyf/hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ title = "CYF Curriculum"

[module]
[[module.imports]]
path = "github.com/CodeYourFuture/curriculum-labs/common-theme"
path = "github.com/CodeYourFuture/curriculum/common-theme"
[[module.imports]]
path = "github.com/CodeYourFuture/curriculum-labs/common-content"
path = "github.com/CodeYourFuture/curriculum/common-content"
[[module.imports.mounts]]
source = "en"
target = "content"
Expand Down
4 changes: 2 additions & 2 deletions org-mcb/hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ title = "MigraCode Barcelona"

[module]
[[module.imports]]
path = "github.com/CodeYourFuture/curriculum-labs/common-theme"
path = "github.com/CodeYourFuture/curriculum/common-theme"
[[module.imports]]
path = "github.com/CodeYourFuture/curriculum-labs/common-content"
path = "github.com/CodeYourFuture/curriculum/common-content"
[[module.imports.mounts]]
source = "en"
target = "content"
Expand Down
Loading