From 73ea3f9e05bf590f2d3da56cbc7c736261f34d10 Mon Sep 17 00:00:00 2001 From: choldgraf Date: Tue, 19 Nov 2024 19:29:38 -0800 Subject: [PATCH] Use YML file for people --- .gitignore | 4 +++- docs/data/team.yml | 28 ++++++++++++++++++++++++++++ docs/myst.yml | 2 ++ docs/src/team.mjs | 39 +++++++++++++++++++++++++++++++++++++++ docs/team.md | 26 +++----------------------- package.json | 16 ++++++++++++++++ 6 files changed, 91 insertions(+), 24 deletions(-) create mode 100644 docs/data/team.yml create mode 100644 docs/src/team.mjs create mode 100644 package.json diff --git a/.gitignore b/.gitignore index 8a4c624..c75f0ef 100644 --- a/.gitignore +++ b/.gitignore @@ -159,4 +159,6 @@ cython_debug/ # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ -/_build/ \ No newline at end of file +/_build/ +package-lock.json +node_modules \ No newline at end of file diff --git a/docs/data/team.yml b/docs/data/team.yml new file mode 100644 index 0000000..f315f2c --- /dev/null +++ b/docs/data/team.yml @@ -0,0 +1,28 @@ +# Listed in alphabetical order, beginning with the Steering Council +# Steering Council +- name: Chris Holdgraf + github: choldgraf + team: Steering Council + affiliation: 2i2c +- name: Greg Caporaso + github: gregcaporaso + team: Steering Council + affiliation: Northern Arizona University +- name: Rowan Cockett + github: rowanc1 + team: Steering Council + affiliation: CurveNote + +# Core Team +- name: Angus Hollands + github: agoose77 + team: Core Team + affiliation: 2i2c +- name: Frank W Koch + github: fwkoch + team: Core Team + affiliation: CurveNote +- name: Steve Purves + github: stevejpurves + team: Core Team + affiliation: CurveNote \ No newline at end of file diff --git a/docs/myst.yml b/docs/myst.yml index 597eb5c..47cb4f1 100644 --- a/docs/myst.yml +++ b/docs/myst.yml @@ -15,6 +15,8 @@ project: license: CC0-1.0 references: jupyter_governance: https://jupyter.org/governance/ + plugins: + - src/team.mjs toc: - file: index.md - file: team.md diff --git a/docs/src/team.mjs b/docs/src/team.mjs new file mode 100644 index 0000000..e420713 --- /dev/null +++ b/docs/src/team.mjs @@ -0,0 +1,39 @@ +import yaml from "js-yaml"; +import fs from "fs"; + +// Read and parse team data +const teamData = yaml.load(fs.readFileSync("data/team.yml", "utf8")); +const teamDirective = { + name: "team", + doc: "Display members of a team!", + arg: { type: String, doc: "The team name.", required: true }, + run(data, vfile, ctx) { + const team = data.arg; + var cards = []; + teamData.forEach(ii => { + if (ii["team"] === team) { + cards.push(` +:::{card} ${ii["name"]} +:link: https://github.com/${ii["github"]} +:footer: **Affiliation:** ${ii['affiliation']} +![${ii["name"]} avatar](https://github.com/${ii["github"]}.png) +:::`) + } + }); + if (cards.length === 0) { + throw new Error(`Team ${team} not found.`); + } + const grid = ctx.parseMyst(` +::::{grid} 3 +${cards.join("\n")} +::::`).children[0]; + return [grid]; + }, +}; + +const plugin = { + name: "Compass team plugins", + directives: [teamDirective], +}; + +export default plugin; \ No newline at end of file diff --git a/docs/team.md b/docs/team.md index 71589da..68501e7 100644 --- a/docs/team.md +++ b/docs/team.md @@ -18,24 +18,7 @@ The Steering Council Mailing List is: [**`jupyter-book-council@googlegroups.com` ### Members -```{grid} 3 -:::{card} Chris Holdgraf -:link: https://github.com/choldgraf -![Rowan avatar](https://github.com/choldgraf.png) -Affiliation: 2i2c -::: - -:::{card} Greg Caporaso -:link: https://github.com/gregcaporaso -![Rowan avatar](https://github.com/gregcaporaso.png) -Affiliation: Northern Arizona University -::: - -:::{card} Rowan Cockett -:link: https://github.com/rowanc1 -![Rowan avatar](https://github.com/rowanc1.png) -Affiliation: Curvenote -::: +```{team} Steering Council ``` (core-team)= @@ -44,11 +27,8 @@ Affiliation: Curvenote Our core team consists of the following people (in alphabetical order). -- [`@agoose77`](https://github.com/agoose77) -- [`@choldgraf`](https://github.com/choldgraf) -- [`@fwkoch`](https://github.com/fwkoch) -- [`@rowanc1`](https://github.com/rowanc1) -- [`@stevejpurves`](https://github.com/stevejpurves) +:::{team} Core Team +::: ## Software Steering Council Representative diff --git a/package.json b/package.json new file mode 100644 index 0000000..e7ad38e --- /dev/null +++ b/package.json @@ -0,0 +1,16 @@ +{ + "name": "jupyter-book-team-compass", + "repository": { + "type": "git", + "url": "https://github.com/jupyter-book/team-compass.git" + }, + "devDependencies": { + "js-yaml": "^4.1.0", + "myst-cli": "^1.3.18" + }, + "engines": { + "npm": ">=10.7.0", + "node": ">=18.0.0" + }, + "packageManager": "npm@10.7.0" +}