Skip to content
This repository was archived by the owner on Jun 27, 2023. It is now read-only.

Commit 2091b33

Browse files
committed
Setup npm tooling for scribejs use
Documented basic weekly usage. Added default settings to .scribejs.json Setup private npm module for installing all the things.
1 parent b3d0ac3 commit 2091b33

File tree

5 files changed

+261
-0
lines changed

5 files changed

+261
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules/
2+
_site/

.scribejs.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"group": "pwg",
3+
"nicknames": "assets/nicknames.json",
4+
"jekyll": "kd"
5+
}

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,42 @@ Use the standard fork, branch, and pull request workflow to propose changes to t
2020
Editorial changes that improve the readability of the spec or correct spelling or grammatical mistakes are welcome.
2121

2222
Please read [CONTRIBUTING.md](CONTRIBUTING.md), about licensing contributions.
23+
24+
## Tools
25+
26+
Generating weekly minutes is done via the
27+
[scribejs](https://github.com/w3c/scribejs) script and some additional
28+
configuration settings provided in this repo (see `.scribejs.json`).
29+
30+
To use this repository's scribejs setup first install the tools...
31+
32+
```bash
33+
$ npm install
34+
```
35+
36+
Then run the following (with date
37+
information changed to match your scenario):
38+
39+
```bash
40+
$ npm run scribejs -- -d 2018-07-09 -o Meetings/Minutes/2018/2018-07-09-pwg.md
41+
```
42+
43+
This will request the IRC logs for the correct channel and convert them into
44+
the Kramdown (a more feature rich form of Markdown) with settings to match this
45+
repositories other documents.
46+
47+
If you need to make edits to the IRC log before generating the output (due to
48+
incorrect scribenick or similar), you can download the W3C logs from URLs such
49+
as `https://www.w3.org/2018/07/09-pwg-irc.txt`. Once downloaded, you can
50+
reference that input document directly (rather than using the automagic
51+
date-based retrieval).
52+
53+
For example:
54+
55+
```bash
56+
$ curl https://www.w3.org/2018/07/09-pwg-irc.txt > 2018-07-09-pwg-irc.txt
57+
$ npm run scribejs -- 2018-07-09-pwg-irc.txt -d 2018-07-09 -o Meetings/Minutes/2018/2018-07-09-pwg.md
58+
```
59+
Edit the .txt file and repeat the `npm run scribejs` line as necessary. Once
60+
finished, you can commit the `.md` file and delete the `.txt` file (or keep it
61+
for your records).

package-lock.json

Lines changed: 188 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"private": true,
3+
"name": "publ-wg",
4+
"version": "0.1.0",
5+
"description": "Node tooling for the Publishing Working Group site",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1",
8+
"scribejs": "scribejs -c .scribejs.json"
9+
},
10+
"repository": {
11+
"type": "git",
12+
"url": "git+https://github.com/w3c/publ-wg.git"
13+
},
14+
"keywords": [
15+
"W3C",
16+
"publishing"
17+
],
18+
"author": "W3C Members",
19+
"license": "W3C-20150513",
20+
"bugs": {
21+
"url": "https://github.com/w3c/publ-wg/issues"
22+
},
23+
"homepage": "https://github.com/w3c/publ-wg#readme",
24+
"devDependencies": {
25+
"scribejs": "git+https://github.com/w3c/scribejs.git"
26+
}
27+
}

0 commit comments

Comments
 (0)