Skip to content

Commit 1541c01

Browse files
gvwilsongvwilson
committed
merge: combine GitHub Pages Jekyll template with existing work
- also change 'Agustin' rather than 'Agus'
1 parent 749e7b4 commit 1541c01

Some content is hidden

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

52 files changed

+784
-40
lines changed

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1+
.jekyll-cache
2+
.jekyll-metadata
13
.DS_Store
4+
_site
25
*~

‎GOVERNANCE.md

+13-9
Original file line numberDiff line numberDiff line change
@@ -46,29 +46,33 @@ while the third lists decisions made to date.
4646
## Voting Members
4747

4848
1. The following people are currently voting members of this project:
49+
1. Shritesh **Bhattarai**
4950
1. Luke **Boswell**
51+
1. Sophie **Collard**
52+
1. Ashley **Davis**
53+
1. Eli **Dowling**
54+
1. Kyril **Dziamura**
5055
1. Richard **Feldman** (co-editor)
56+
1. Hristo **Georgiev**
5157
1. Norbert **Hajagos**
5258
1. Stuart **Hinson**
59+
1. Monica **McGuigan**
60+
1. Fabian **Schmalzried**
61+
1. Isaac **Van Doren**
5362
1. Anton **Van Moere** (co-editor)
5463
1. Greg **Wilson** (co-editor)
5564
1. Jasper **Woudenberg**
65+
1. Agus **Zubiaga**
5666

57-
2. To become a voting member, a person must:
58-
1. select a topic in the issue list in this project's GitHub repository;
59-
2. have their selection approved by the co-editors; *and*
60-
3. submit a pull request creating a sub-directory for their topic with an `index.md` file.
61-
62-
3. Once ten (10) people have qualified as members under rule #2,
63-
further additions will be made as follows:
67+
2. To become a voting member:
6468
1. An existing voting member must file a "governance" issue in the repository
6569
to propose the addition.
6670
2. If there are no objections after 72 hours,
6771
the addition will go through the procedure described in "Making Decisions" above.
6872

69-
4. Voting members may resign from the project at any time.
73+
3. Voting members may resign from the project at any time.
7074

71-
5. Voting members may lose their vote if a proposal to that effect is passed
75+
4. Voting members may lose their vote if a proposal to that effect is passed
7276
according to the procedure described in "Making Decisions" above.
7377
1. A proposal to remove someone's vote may not contain any other business.
7478
2. Each person must be the subject of a separate proposal.

‎README.md

+28-1
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@ that most programmers have never encountered.
2424
| Stuart Hinson | stuarth | pattern matching | match |
2525
| Monica McGuigan | monmcguigan | JSON codec | json |
2626
| Fabian Schmalzried | FabHof | binary data packing | binary |
27+
| Isaac Van Doren | isaacvando | compression | compress |
2728
| Isaac Van Doren | isaacvando | HTML templates | template |
2829
| Jasper Woudenberg | jwoudenberg | continuous integration | ci |
29-
| Agus Zubiaga | agu-z | HTML parser | parser |
30+
| Agustin Zubiaga | agu-z | HTML parser | parser |
3031

3132
## Learner Persona
3233

@@ -104,9 +105,35 @@ that most programmers have never encountered.
104105
please include an `index.md` Markdown file
105106
with point-form notes about the design of the code.
106107

108+
## Structure
109+
110+
We are currently building this site using [Jekyll][jekyll]
111+
(the default static site generator for GitHub Pages);
112+
we will convert to something Roc-based soon.
113+
114+
- Project
115+
- `./CODE_OF_CONDUCT.md`: code of conduct
116+
- `./GOVERNANCE.md`: how this project is run`
117+
- `./LICENSE.md`: license
118+
- `./README.md`: this file
119+
- `./index.md`: home page
120+
- `./*_.md` (trailing underscore): create website pages for project files
121+
- `*/index.md`: chapters and appendices
122+
- `./*.css` and `./favicon.svg`: for generated website
123+
- Jekyll
124+
- `./_config.yml`: configuration
125+
- `./_data/`: data files (see below)
126+
- `./_includes/`: inclusions
127+
- `./_layouts/default.html`: our page template
128+
- Data files
129+
- `_data/contrib.yml`: contributors (use GitHub ID as primary key)
130+
- `_data/order.yml`: chapters and appendices in order (use slug as primary key)
131+
- `_data/topic.yml`: chapter and appendix information (use slug as primary key)
132+
107133
[assigned]: https://github.com/roc-lang/book-of-examples/labels/assigned
108134
[cc-by-nc-nd]: https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode
109135
[help-wanted]: https://github.com/roc-lang/book-of-examples/labels/help-wanted
136+
[jekyll]: https://jekyllrb.com/
110137
[mit-license]: https://opensource.org/license/MIT
111138
[repo]: https://github.com/roc-lang/book-of-examples
112139
[roc]: https://www.roc-lang.org/

‎_config.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
title: "Software Design by Example in Roc"
2+
repository: roc-lang/book-of-examples
3+
editors:
4+
- "rtfeldman"
5+
- "Anton-4"
6+
- "gvwilson"
7+
lang: en
8+
9+
baseurl: /book-of-examples
10+
11+
defaults:
12+
- scope:
13+
path: "" # an empty string here means all files in the project
14+
values:
15+
layout: "default"
16+
17+
exclude:
18+
- CODE_OF_CONDUCT.md
19+
- GOVERNANCE.md
20+
- LICENSE.md
21+
- README.md
22+
- Gemfile
23+
- Gemfile.lock
24+
- '.#*'
25+
- '*~'
26+
27+
plugins:
28+
- jekyll-redirect-from
29+
- jekyll-sitemap

‎_data/contrib.yml

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
- family: "Bhattarai"
2+
personal: "Shritesh"
3+
github: "shritesh"
4+
5+
- family: "Boswell"
6+
personal: "Luke"
7+
github: "lukewilliamboswell"
8+
9+
- family: "Collard"
10+
personal: "Sophie"
11+
github: "sophiecollard"
12+
13+
- family: "Davis"
14+
personal: "Ashley"
15+
github: "ashleydavis"
16+
17+
- family: "Dowling"
18+
personal: "Eli"
19+
github: "faldor20"
20+
21+
- family: "Dziamura"
22+
personal: "Kyril"
23+
github: "wontem"
24+
25+
- family: "Feldman"
26+
personal: "Richard"
27+
github: "rtfeldman"
28+
29+
- family: "Georgiev"
30+
personal: "Hristo"
31+
github: "hristog"
32+
33+
- family: "Hajagos"
34+
personal: "Norbert"
35+
github: "HajagosNorbert"
36+
37+
- family: "Hajagos"
38+
personal: "Norbert"
39+
github: "HajagosNorbert"
40+
41+
- family: "Hinson"
42+
personal: "Stuart"
43+
github: "stuarth"
44+
45+
- family: "McGuigan"
46+
personal: "Monica"
47+
github: "monmcguigan"
48+
49+
- family: "Schmalzried"
50+
personal: "Fabian"
51+
github: "FabHof"
52+
53+
- family: "Van Doren"
54+
personal: "Isaac"
55+
github: "isaacvando"
56+
57+
- family: "Van Moere"
58+
personal: "Anton"
59+
github: "Anton-4"
60+
61+
- family: "Wilson"
62+
personal: "Greg"
63+
github: "gvwilson"
64+
65+
- family: "Woudenberg"
66+
personal: "Jasper"
67+
github: "jwoudenberg"
68+
69+
- family: "Zubiaga"
70+
personal: "Agustin"
71+
github: "agu-z"

‎_data/glossary.yml

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# 1
2+
3+
# A
4+
5+
# B
6+
7+
# C
8+
9+
# D
10+
11+
# E
12+
13+
# F
14+
15+
- key: functional_programming
16+
en:
17+
term: "functional programming"
18+
def: >
19+
A programming paradigm in which programs map existing values to new values.
20+
21+
# G
22+
23+
# H
24+
25+
# I
26+
27+
# J
28+
- key: json
29+
en:
30+
term: JSON (JavaScript Object Notation)
31+
def: >
32+
A way to represent data by combining Booleans, numbers, and character strings
33+
in lists and key-value structures.
34+
35+
# K
36+
37+
# L
38+
39+
# M
40+
41+
# N
42+
43+
# O
44+
45+
# P
46+
47+
# Q
48+
49+
# R
50+
51+
# S
52+
53+
# T
54+
55+
# U
56+
57+
# V
58+
59+
# W
60+
61+
# X
62+
63+
# Y
64+
65+
# Z

‎_data/order.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
chapters:
2+
- intro
3+
- backup
4+
- diff
5+
- json
6+
- binary
7+
- ci
8+
- editor
9+
- parser
10+
- template
11+
- svg
12+
- match
13+
- completion
14+
- proptest
15+
- des
16+
- ftp
17+
- gallery
18+
- finale
19+
appendices:
20+
- license
21+
- references
22+
- glossary
23+
- conduct
24+
- governance

‎_data/references.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
- key: "roc_tutorial"
2+
author: "Various authors"
3+
title: "The Roc Language Tutorial"
4+
url: "https://www.roc-lang.org/tutorial"
5+
details: >
6+
Last viewed 2024-03-29.

‎_data/topic.yml

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
- slug: "backup"
2+
title: "File Backup"
3+
github:
4+
- "wontem"
5+
6+
- slug: "binary"
7+
title: "Binary Data Packing"
8+
github:
9+
- "FabHof"
10+
11+
- slug: "ci"
12+
title: "Continuous Integration"
13+
github:
14+
- "jwoudenberg"
15+
16+
- slug: "completion"
17+
title: "Autocompletion"
18+
github:
19+
- "faldor20"
20+
21+
- slug: "conduct"
22+
title: "Code of Conduct"
23+
24+
- slug: "des"
25+
title: "Discrete Event Simulation"
26+
github:
27+
- "HajagosNorbert"
28+
29+
- slug: "diff"
30+
title: "File Diffing"
31+
github:
32+
- "hristog"
33+
34+
- slug: "editor"
35+
title: "A Text Editor"
36+
github:
37+
- "lukewilliamboswell"
38+
39+
- slug: "finale"
40+
title: "Conclusion"
41+
github:
42+
- "gvwilson"
43+
44+
- slug: "ftp"
45+
title: "File Transfer"
46+
github:
47+
- "HajagosNorbert"
48+
49+
- slug: "gallery"
50+
title: "A Thumbnail Gallery"
51+
github:
52+
- "ashleydavis"
53+
54+
- slug: "glossary"
55+
title: "Glossary"
56+
57+
- slug: "governance"
58+
title: "Governance"
59+
60+
- slug: "intro"
61+
title: "Introduction"
62+
github:
63+
- "rtfeldman"
64+
- "Anton-4"
65+
66+
- slug: "json"
67+
title: "JSON Encoding and Decoding"
68+
github:
69+
- "monmcguigan"
70+
71+
- slug: "license"
72+
title: "License"
73+
74+
- slug: "match"
75+
title: "Pattern Matching"
76+
github:
77+
- "stuarth"
78+
79+
- slug: "parser"
80+
title: "An HTML Parser"
81+
github:
82+
- "agu-z"
83+
84+
- slug: "proptest"
85+
title: "Property-Based Testing"
86+
github:
87+
- "sophiecollard"
88+
89+
- slug: "references"
90+
title: "References"
91+
92+
- slug: "svg"
93+
title: "SVG Rendering"
94+
github:
95+
- "shritesh"
96+
97+
- slug: "template"
98+
title: "HTML Templates"
99+
github:
100+
- "isaacvando"

0 commit comments

Comments
 (0)