Skip to content

Commit

Permalink
merge: combine GitHub Pages Jekyll template with existing work
Browse files Browse the repository at this point in the history
- also change 'Agustin' rather than 'Agus'
  • Loading branch information
gvwilson committed Apr 10, 2024
1 parent 749e7b4 commit 96e9963
Show file tree
Hide file tree
Showing 93 changed files with 3,515 additions and 40 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
.jekyll-cache
.jekyll-metadata
.DS_Store
_site
*~
22 changes: 13 additions & 9 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,29 +46,33 @@ while the third lists decisions made to date.
## Voting Members

1. The following people are currently voting members of this project:
1. Shritesh **Bhattarai**
1. Luke **Boswell**
1. Sophie **Collard**
1. Ashley **Davis**
1. Eli **Dowling**
1. Kyril **Dziamura**
1. Richard **Feldman** (co-editor)
1. Hristo **Georgiev**
1. Norbert **Hajagos**
1. Stuart **Hinson**
1. Monica **McGuigan**
1. Fabian **Schmalzried**
1. Isaac **Van Doren**
1. Anton **Van Moere** (co-editor)
1. Greg **Wilson** (co-editor)
1. Jasper **Woudenberg**
1. Agus **Zubiaga**

2. To become a voting member, a person must:
1. select a topic in the issue list in this project's GitHub repository;
2. have their selection approved by the co-editors; *and*
3. submit a pull request creating a sub-directory for their topic with an `index.md` file.

3. Once ten (10) people have qualified as members under rule #2,
further additions will be made as follows:
2. To become a voting member:
1. An existing voting member must file a "governance" issue in the repository
to propose the addition.
2. If there are no objections after 72 hours,
the addition will go through the procedure described in "Making Decisions" above.

4. Voting members may resign from the project at any time.
3. Voting members may resign from the project at any time.

5. Voting members may lose their vote if a proposal to that effect is passed
4. Voting members may lose their vote if a proposal to that effect is passed
according to the procedure described in "Making Decisions" above.
1. A proposal to remove someone's vote may not contain any other business.
2. Each person must be the subject of a separate proposal.
Expand Down
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ that most programmers have never encountered.
| Stuart Hinson | stuarth | pattern matching | match |
| Monica McGuigan | monmcguigan | JSON codec | json |
| Fabian Schmalzried | FabHof | binary data packing | binary |
| Isaac Van Doren | isaacvando | compression | compress |
| Isaac Van Doren | isaacvando | HTML templates | template |
| Jasper Woudenberg | jwoudenberg | continuous integration | ci |
| Agus Zubiaga | agu-z | HTML parser | parser |
| Agustin Zubiaga | agu-z | HTML parser | parser |

## Learner Persona

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

## Structure

We are currently building this site using [Jekyll][jekyll]
(the default static site generator for GitHub Pages);
we will convert to something Roc-based soon.

- Project
- `./CODE_OF_CONDUCT.md`: code of conduct
- `./GOVERNANCE.md`: how this project is run`
- `./LICENSE.md`: license
- `./README.md`: this file
- `./index.md`: home page
- `./*_.md` (trailing underscore): create website pages for project files
- `*/index.md`: chapters and appendices
- `./*.css` and `./favicon.svg`: for generated website
- Jekyll
- `./_config.yml`: configuration
- `./_data/`: data files (see below)
- `./_includes/`: inclusions
- `./_layouts/default.html`: our page template
- Data files
- `_data/contrib.yml`: contributors (use GitHub ID as primary key)
- `_data/order.yml`: chapters and appendices in order (use slug as primary key)
- `_data/topic.yml`: chapter and appendix information (use slug as primary key)

[assigned]: https://github.com/roc-lang/book-of-examples/labels/assigned
[cc-by-nc-nd]: https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode
[help-wanted]: https://github.com/roc-lang/book-of-examples/labels/help-wanted
[jekyll]: https://jekyllrb.com/
[mit-license]: https://opensource.org/license/MIT
[repo]: https://github.com/roc-lang/book-of-examples
[roc]: https://www.roc-lang.org/
Expand Down
30 changes: 30 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
title: "Software Design by Example in Roc"
repository: roc-lang/book-of-examples
editors:
- "rtfeldman"
- "Anton-4"
- "gvwilson"
lang: en

baseurl: /book-of-examples
destination: docs

defaults:
- scope:
path: "" # an empty string here means all files in the project
values:
layout: "default"

exclude:
- CODE_OF_CONDUCT.md
- GOVERNANCE.md
- LICENSE.md
- README.md
- Gemfile
- Gemfile.lock
- '.#*'
- '*~'

plugins:
- jekyll-redirect-from
- jekyll-sitemap
71 changes: 71 additions & 0 deletions _data/contrib.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
- family: "Bhattarai"
personal: "Shritesh"
github: "shritesh"

- family: "Boswell"
personal: "Luke"
github: "lukewilliamboswell"

- family: "Collard"
personal: "Sophie"
github: "sophiecollard"

- family: "Davis"
personal: "Ashley"
github: "ashleydavis"

- family: "Dowling"
personal: "Eli"
github: "faldor20"

- family: "Dziamura"
personal: "Kyril"
github: "wontem"

- family: "Feldman"
personal: "Richard"
github: "rtfeldman"

- family: "Georgiev"
personal: "Hristo"
github: "hristog"

- family: "Hajagos"
personal: "Norbert"
github: "HajagosNorbert"

- family: "Hajagos"
personal: "Norbert"
github: "HajagosNorbert"

- family: "Hinson"
personal: "Stuart"
github: "stuarth"

- family: "McGuigan"
personal: "Monica"
github: "monmcguigan"

- family: "Schmalzried"
personal: "Fabian"
github: "FabHof"

- family: "Van Doren"
personal: "Isaac"
github: "isaacvando"

- family: "Van Moere"
personal: "Anton"
github: "Anton-4"

- family: "Wilson"
personal: "Greg"
github: "gvwilson"

- family: "Woudenberg"
personal: "Jasper"
github: "jwoudenberg"

- family: "Zubiaga"
personal: "Agustin"
github: "agu-z"
65 changes: 65 additions & 0 deletions _data/glossary.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# 1

# A

# B

# C

# D

# E

# F

- key: functional_programming
en:
term: "functional programming"
def: >
A programming paradigm in which programs map existing values to new values.
# G

# H

# I

# J
- key: json
en:
term: JSON (JavaScript Object Notation)
def: >
A way to represent data by combining Booleans, numbers, and character strings
in lists and key-value structures.
# K

# L

# M

# N

# O

# P

# Q

# R

# S

# T

# U

# V

# W

# X

# Y

# Z
24 changes: 24 additions & 0 deletions _data/order.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
chapters:
- intro
- backup
- diff
- json
- binary
- ci
- editor
- parser
- template
- svg
- match
- completion
- proptest
- des
- ftp
- gallery
- finale
appendices:
- license
- references
- glossary
- conduct
- governance
6 changes: 6 additions & 0 deletions _data/references.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
- key: "roc_tutorial"
author: "Various authors"
title: "The Roc Language Tutorial"
url: "https://www.roc-lang.org/tutorial"
details: >
Last viewed 2024-03-29.
100 changes: 100 additions & 0 deletions _data/topic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
- slug: "backup"
title: "File Backup"
github:
- "wontem"

- slug: "binary"
title: "Binary Data Packing"
github:
- "FabHof"

- slug: "ci"
title: "Continuous Integration"
github:
- "jwoudenberg"

- slug: "completion"
title: "Autocompletion"
github:
- "faldor20"

- slug: "conduct"
title: "Code of Conduct"

- slug: "des"
title: "Discrete Event Simulation"
github:
- "HajagosNorbert"

- slug: "diff"
title: "File Diffing"
github:
- "hristog"

- slug: "editor"
title: "A Text Editor"
github:
- "lukewilliamboswell"

- slug: "finale"
title: "Conclusion"
github:
- "gvwilson"

- slug: "ftp"
title: "File Transfer"
github:
- "HajagosNorbert"

- slug: "gallery"
title: "A Thumbnail Gallery"
github:
- "ashleydavis"

- slug: "glossary"
title: "Glossary"

- slug: "governance"
title: "Governance"

- slug: "intro"
title: "Introduction"
github:
- "rtfeldman"
- "Anton-4"

- slug: "json"
title: "JSON Encoding and Decoding"
github:
- "monmcguigan"

- slug: "license"
title: "License"

- slug: "match"
title: "Pattern Matching"
github:
- "stuarth"

- slug: "parser"
title: "An HTML Parser"
github:
- "agu-z"

- slug: "proptest"
title: "Property-Based Testing"
github:
- "sophiecollard"

- slug: "references"
title: "References"

- slug: "svg"
title: "SVG Rendering"
github:
- "shritesh"

- slug: "template"
title: "HTML Templates"
github:
- "isaacvando"
Loading

0 comments on commit 96e9963

Please sign in to comment.