c3gW-training-catalog

[WARNING]

Under Construction: The catalog is actively being developed, and workshop pages will be added progressively.

Expect changes: Content, structure, and features may change without notice.

Central hub for C3G workshops, tutorials, and training resources, built with Quarto.

Website

Open Catalog

C3G workshops, tutorials, and training resources

What this repository contains

• A Quarto website with:
  • Workshop catalog
  • Partner workshop catalog
  • Tutorial directory catalog
  • Contribution guidance
• A build-time script that fetches catalog data from GitHub and writes:
  • data/workshops-data.json

Main pages:

• Home: index.qmd
• Workshops: workshops.qmd
• Tutorials: tutorials.qmd
• Contribute: contribute.qmd

How catalog data is generated

Catalog data is generated by:

• scripts/fetch_workshops_data.py

This script builds data/workshops-data.json with:

• mainWorkshops
• partnerWorkshops
• tutorials
• shared category tags and source metadata

Indexing rules

Main workshops (C3G org)

A repository is included when it:

• belongs to c3g
• name starts with c3gW
• has GitHub topic workshop

Partner workshops

Partner repositories are manually listed in:

• MANUAL_PARTNER_REPO_LIST in scripts/fetch_workshops_data.py

Optional topic overrides:

• MANUAL_PARTNER_TOPIC_OVERRIDES

Tutorials (c3g/c3gW-Tutorials)

Top-level directories in c3g/c3gW-Tutorials are indexed as tutorial entries.

For each tutorial directory, metadata is parsed from that directory README:

• # Description section -> card description
• # Tags section -> catalog tags

The script also records the latest commit date for that directory path and exposes it as pushed_at (used as Updated date in the Tutorials catalog).

Local development

1. Refresh catalog data

python3 scripts/fetch_workshops_data.py

2. Preview site

quarto preview

3. Render site

quarto render

Optional: auto-refresh data during build

You can enable the pre-render hook in _quarto.yml so data refresh runs automatically before render.

Contributing

Please read:

• contribute.qmd

For workshop contribution rules, see naming convention (c3gW...), required workshop topic, and partner workshop registration path.

Troubleshooting

• If catalogs are empty, regenerate data:
  • python3 scripts/fetch_workshops_data.py
• If preview fails, verify:
  • Quarto is installed
  • Python 3 is available
  • Network access to GitHub API is available

License

See LICENSE.