FIAF Moving Image Cataloguing Manual

A static site build of the FIAF Moving Image Cataloguing Manual, published at: https://fiaf-cataloguing-manual.s3-website.fr-par.scw.cloud/

---

Site setup

The site is built with MkDocs using the Material theme.

Directory structure

fiaf-cataloguing-manual/
├── markdown/              ← master content — one index.md per section/subsection
│   ├── preliminary/
│   ├── works/
│   ├── variants/
│   ├── manifestations/
│   ├── items/
│   ├── boundaries/
│   ├── titles/
│   ├── aggregates/
│   ├── agents/
│   ├── events/
│   ├── other-relationships/
│   ├── appendices/
│   │   ├── cataloguers-notes/
│   │   ├── element-comparison/
│   │   ├── rights/
│   │   ├── record-examples/
│   │   ├── bibliography/
│   │   └── element-list/
│   ├── assets/            ← CSS, logo, favicon
│   └── diagrams/          ← diagram images
├── overrides/
│   └── partials/          ← MkDocs Material theme overrides
├── mkdocs.yml             ← site configuration and navigation
├── compose.yml            ← Docker Compose setup for local preview
└── SYNTAX.md              ← Markdown syntax guide for contributors

Each chapter index is {chapter}/index.md; subsections are {chapter}/{slug}/index.md.

Local preview

With Docker:

docker compose up

Without Docker (Python 3.12 recommended):

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve

The site is served at http://localhost:8000.

Deployment

On every push to the develop branch, GitHub Actions builds the site and syncs it to a Scaleway Object Storage bucket in the Paris region using the AWS CLI.

The workflow requires two repository secrets:

Secret	Description
SCW_ACCESS_KEY_ID	Scaleway API access key ID
SCW_SECRET_ACCESS_KEY	Scaleway API secret key

Editorial workflow

• Work on feature branches, PR to develop
• Edit Markdown files directly in markdown/
• Navigation changes require updating mkdocs.yml
• Issues are tracked at https://github.com/FIAF/fiaf-cataloguing-manual/issues