Skip to content

Commit 5b47fb9

Browse files
docs: point devs to the running-locally guide (#1924)
The token error said "Check the README" but the README had no local setup instructions, and the running-locally guide pinned the wrong Hugo version. - README: add a "Running locally" section linking to the guide - github-auth.html: point the missing-token error at the running-locally guide instead of the README - running-locally guide: fix Hugo version 0.136.5 -> 0.136.3 to match netlify.toml Co-authored-by: abdishakoor-dev <294276791+abdishakoor-dev@users.noreply.github.com>
1 parent d72dc8c commit 5b47fb9

3 files changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ Common is tightly integrated with GitHub. Really the main content should always
3434

3535
Each org or team configures its own Hugo site that mounts the common theme and content modules, and then makes any customisations they need and deploys it wherever they want. You can use any repo to do this and your site can be as simple as a `hugo.toml` and a `content/_index.md`. We'd love for you to use Common, too!
3636

37+
## Running locally
38+
39+
To build and run the curriculum on your own machine (install Hugo/Go/npm, create a GitHub token, and start the dev server), follow our [Building the Curriculum Locally](https://curriculum.codeyourfuture.io/guides/contributing/running-locally/) guide. The source for that guide lives at [`org-cyf-guides/content/contributing/running-locally/index.md`](org-cyf-guides/content/contributing/running-locally/index.md).
40+
3741
## Examples
3842

3943
- https://curriculum.codeyourfuture.io/

common-theme/layouts/partials/github-auth.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
{{ if ne $token "" }}
44
{{ $headers = dict "headers" (dict "Authorization" (print "Bearer " $token)) }}
55
{{ else }}
6-
{{ errorf "🏷️ Site needs a HUGO_CURRICULUM_GITHUB_BEARER_TOKEN. Check the README" }}
6+
{{ errorf "🏷️ Site needs a HUGO_CURRICULUM_GITHUB_BEARER_TOKEN. See https://curriculum.codeyourfuture.io/guides/contributing/running-locally/" }}
77
{{ end }}
88
{{ return $headers }}

org-cyf-guides/content/contributing/running-locally/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Our curriculum is built on top of [Hugo](https://gohugo.io/) and requires some p
1414
- `npm`
1515

1616
> [!WARNING]
17-
> We require `v0.136.5-extended` of `hugo` which can be downloaded from [GitHub](https://github.com/gohugoio/hugo/releases/tag/v0.136.5) and manually added to your `$PATH`.
17+
> We require `v0.136.3-extended` of `hugo` (the version pinned in `netlify.toml`), which can be downloaded from [GitHub](https://github.com/gohugoio/hugo/releases/tag/v0.136.3) and manually added to your `$PATH`.
1818
>
1919
> Later versions will induce an error and building will fail.
2020
>

0 commit comments

Comments
 (0)