Skip to content

Commit 7ec91e5

Browse files
dvberkeldvberkel
authored
Initial commit
0 parents  commit 7ec91e5

31 files changed

+357
-0
lines changed

‎.github/workflows/publish-material.yaml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Publish Workshop Material
2+
on:
3+
push:
4+
branches:
5+
- main
6+
jobs:
7+
create-archive:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v2
11+
- name: Setup mdBook
12+
uses: peaceiris/actions-mdbook@v1
13+
- name: Build artifact
14+
run: make all
15+
- name: Create release
16+
uses: marvinpinto/action-automatic-releases@latest
17+
with:
18+
repo_token: ${{ secrets.GITHUB_TOKEN }}
19+
automatic_release_tag: latest
20+
files: workshop-material.tar.gz

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
public
2+
build
3+
workshop-material.tar.gz

‎LICENSE

+121
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.

‎Makefile

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
ARCHIVE=workshop-material.tar.gz
2+
MATERIAL_DIR=build
3+
WEBPAGE_DIR=public
4+
SUB_DIRECTORIES=workshop resources
5+
CLEAN_TARGETS=$(addsuffix clean,$(SUB_DIRECTORIES))
6+
7+
.PHONY: all clean ${SUB_DIRECTORIES} ${CLEAN_TARGETS}
8+
9+
all: ${ARCHIVE} ${WEBPAGE_DIR} docs/workshop
10+
${ARCHIVE}: ${MATERIAL_DIR}
11+
tar cvfz $@ $<
12+
13+
${MATERIAL_DIR}: ${SUB_DIRECTORIES} ${REFERENCE}
14+
mkdir -p $@
15+
cp -rf resources/material/* $@/
16+
cp -rf workshop/guide/book $@/guide
17+
mkdir -p $@/example
18+
cp -rf workshop/example/* $@/example
19+
cp -rf presentation $@/presentation
20+
21+
${SUB_DIRECTORIES}:
22+
${MAKE} -C $@
23+
24+
${WEBPAGE_DIR}: ${MATERIAL_DIR} ${ARCHIVE}
25+
mkdir -p $@
26+
echo "<meta http-equiv=refresh content=0;url=guide/index.html>" > $@/index.html
27+
cp -rf $</guide $@/guide
28+
cp -rf $</presentation $@/presentation
29+
cp resources/public/* $@/
30+
31+
docs/workshop: ${WEBPAGE_DIR}
32+
mkdir -p $@
33+
cp -rf $</* $@
34+
35+
clean: ${CLEAN_TARGETS}
36+
rm -rf ${ARCHIVE} ${MATERIAL_DIR} ${WEBPAGE_DIR} docs/workshop
37+
38+
%clean: %
39+
${MAKE} -C $< clean

‎README.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Workshop Title
2+
This template allows you to quickly flesh out a workshop.
3+
4+
## Usage
5+
There are several ways to proceed. Most importantly is to get all the files in a directory and put them under version control.
6+
Here we describe one way.
7+
8+
1. Crate a directory
9+
2. Enter the directory
10+
3. Use `git init` to put the directory under version control.
11+
4. Add this repository as a remote with `git remote add template [email protected]:fifth-postulate/workshop-template.git`
12+
5. Fetch the remote code `git fetch template`
13+
6. Git checkout the main branch `git checkout -b main template/main`
14+
7. Alter all names to signify the current workshop
15+
8. Rebase to have a tailered commit for your workshop `git rebase -i 76de`
16+
9. Push your fresh workshop to a remote repository of your choicing
17+
18+
## Development
19+
We use Make to automate various tasks in this project. Run
20+
21+
```plain
22+
make
23+
```
24+
25+
To kick things off.

‎docs/image/Makefile

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.PHONY: all clean
2+
3+
SVGS=$(wildcard *.svg)
4+
PNGS=$(SVGS:svg=png)
5+
6+
all: ${PNGS}
7+
@echo "Finished creating pngs"
8+
9+
%.png: %.svg
10+
inkscape -w 200 -D -f $< -e $@
11+
12+
clean:
13+
rm -rf ${PNGS}

‎presentation/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Presentation
2+
This directory contains various presentations. They will be served from the workshop website
3+
4+
## Template
5+
There is a template that can used to kickstart a presentation. To use it copy the template directory.

‎presentation/template/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Template Presentation
2+
One can copy this presentation and adopt it to its needs.
3+
4+
## Serve Locally
5+
To serve the presentation locally on can use the following command:
6+
7+
```
8+
python -m SimpleHTTPServer
9+
```

‎presentation/template/css/starter.css

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blockquote {
2+
border-left-style: solid;
3+
border-left-width: 5px;
4+
border-left-color: gray;
5+
background-color: #F2F3F4;
6+
padding-left: 2em;
7+
padding-right: 2em;
8+
}

‎presentation/template/favicon.ico

15 KB
Binary file not shown.

‎presentation/template/image/.keep

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
included to keep the otherwise empty image directory

‎presentation/template/index.html

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!doctype html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Presentation</title>
6+
<link rel="shortcut icon" type="image/ico" href="favicon.ico"/>
7+
<link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/default.min.css">
8+
<link rel="stylesheet" href="css/starter.css"/>
9+
</head>
10+
<body>
11+
<textarea id="source"></textarea>
12+
<script src="https://remarkjs.com/downloads/remark-latest.min.js"></script>
13+
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS_HTML&delayStartupUntil=configured" type="text/javascript"></script>
14+
<script src="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/highlight.min.js"></script>
15+
<script src="js/app.js"></script>
16+
</body>
17+
</html>

‎presentation/template/js/app.js

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
(function(){
2+
let slideshow = remark.create({
3+
sourceUrl: 'presentation.md'
4+
});
5+
6+
// Setup MathJax
7+
MathJax.Hub.Config({
8+
tex2jax: {
9+
skipTags: ['script', 'noscript', 'style', 'textarea', 'pre']
10+
}
11+
});
12+
MathJax.Hub.Configured();
13+
})();

‎presentation/template/presentation.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
class: middle, center
2+
3+
# A Presentation

‎resources/Makefile

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.PHONY=all
2+
MATERIAL_DIR=material
3+
4+
all:
5+
@echo "finished retrieving external material"

‎resources/material/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.pdf

‎resources/material/keep

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This file is intentionally left blank

‎resources/public/keep

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This file is intentionally left blank

‎workshop/Makefile

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
SUB_DIRECTORIES=guide
2+
CLEAN_TARGETS=$(addsuffix clean,$(SUB_DIRECTORIES))
3+
4+
.PHONY: clean all ${SUB_DIRECTORIES}
5+
6+
all: ${SUB_DIRECTORIES}
7+
${SUB_DIRECTORIES}:
8+
${MAKE} -C $@
9+
10+
clean: ${CLEAN_TARGETS}
11+
%clean: %
12+
${MAKE} -C $< clean

‎workshop/example/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# intentionally left blank

‎workshop/example/keep

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This file is intentionally left blank

‎workshop/guide/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
book

‎workshop/guide/Makefile

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.PHONY: clean images
2+
3+
BOOK=book
4+
SOURCE_DIRECTORY=src
5+
SOURCES=$(shell find ${SOURCE_DIRECTORY} -name '*.md')
6+
7+
${BOOK}: ${SOURCES} images
8+
mdbook build
9+
10+
clean:
11+
mdbook clean
12+
rm -f ${IMAGE_TARGETS}

‎workshop/guide/book.toml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[book]
2+
authors = ["Daan van Berkel"]
3+
language = "en"
4+
multilingual = false
5+
src = "src"
6+
title = "Workshop"
7+
8+
[output.html]
9+
mathjax-support = true
10+
additional-css = ["custom.css"]

‎workshop/guide/custom.css

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/* This css is included in the workshop material. */

‎workshop/guide/src/SUMMARY.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Workshop
2+
3+
[Title](./title.md)
4+
[What to expect](./expectations.md)
5+
6+
# Introduction
7+
* [Origin](./introduction/origin.md)
8+
9+
# Appendices
10+
* [Sources](./appendix/sources.md)

‎workshop/guide/src/appendix/sources.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Sources
2+
The sources for this guide, its examples and references can be found at [the project repository][repo].
3+
4+
It also holds [a downloadable release][release]; a package of all aforementioned items.
5+
6+
[repo]: https://github.com/fifth-postulate/workshop-template
7+
[release]: https://github.com/fifth-postulate/workshop-template/releases

‎workshop/guide/src/expectations.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# What to expect
2+
This book is divided into the following parts
3+
4+
* Introduction
5+
* Appendices
6+
7+
## Introduction
8+
In the introduction part we will set the scene and talk about the our goals.
9+
10+
## Appendices
11+
The appendices are there to provide context that are not naturally placed within the guide. They can be used as a resource for future studies and sometimes inspiration.

‎workshop/guide/src/image/.keep

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
included to keep the otherwise empty image directory

‎workshop/guide/src/introduction/origin.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Origin
2+
Let's talk about this workshop.

‎workshop/guide/src/title.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Workshop
2+
## Subtitle
3+
You are looking at the guide accompanying a workshop about an interesting subject.

0 commit comments

Comments
 (0)