- forge.yaml: the repository's host (Gitea at git.kenschiano.net, limited visibility); the "Report a run" collector, the page's links (data/public/links.json, filled in by site/build.js) and the dataset metadata read it - collection/etl/forge.py: issues, pull requests (merge when checks succeed) and labels for Gitea and GitHub; `python -m collection forge ...` - .gitea/workflows: CI and the daily update (pushes a branch, opens a pull request that merges itself, opens an issue when a source breaks); .github/workflows kept for GitHub - docs: Gitea setup (REPO_SETTINGS), the bot reading atlas files from the repository Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UCzTd31GphpMXDhQqWrCMQ
45 lines
2.7 KiB
Markdown
45 lines
2.7 KiB
Markdown
# Privacy and licences
|
|
|
|
Rules every part of the project follows. If a change would break one, stop and ask first.
|
|
|
|
## What may be published
|
|
|
|
- **Code** is MIT (`LICENSE`). **Data this project produces** is CC BY 4.0 (`DATA_LICENSE.md`). Third-party
|
|
sources keep their own terms.
|
|
- **Community form responses:** published as exported, with email addresses in free-text answers redacted by
|
|
the coding rules (`core/spec/form.yaml`, `core/atlas/coding.py`).
|
|
- **Dragon Register:** only `data/public/register.json`. The raw export has rider names and stays local
|
|
(`data/raw/register/` is git-ignored).
|
|
- **The community route PDF:** never committed or redistributed. Only a fingerprint
|
|
(`data/derived/pdf_fingerprint.json`) so we can tell when it changes, and a link to the original.
|
|
- **Bot data:** only scene fingerprints, short labels, choice text and outcomes. Never game prose, never account
|
|
names. The importer (`collection/etl/transform/bot.py`, rules in `collection/pipeline.yaml`) refuses to write anything that looks like either.
|
|
|
|
## The bot
|
|
|
|
- Ken's bot repository stays private. Only the anonymised import comes here.
|
|
- Account ids are salted and hashed. The salt (`DK_ACCOUNT_SALT`) lives in the environment and is never
|
|
committed.
|
|
- The bot's browser profiles, `.env` and credential files are never committed or shared.
|
|
|
|
## Sources we do not scrape
|
|
|
|
- **Discord:** not without the server admins' consent; never with a personal account token.
|
|
- **Reddit:** only through Reddit's official API with an app key (`REDDIT_CLIENT_ID` / `REDDIT_CLIENT_SECRET`),
|
|
never by page scraping. Only dragonkind.com result links are taken from the threads; usernames and comment text
|
|
are never kept, and each result page is read and added by hand (`collection/manual/reddit_results.yaml`).
|
|
|
|
## Run reports
|
|
|
|
"Report a run" creates an issue on the Atlas's repository (forge.yaml), visible to everyone who can see it. The pipeline keeps only the issue number, the date and the answers
|
|
(`data/public/reports.json`); GitHub usernames are dropped. The form asks people not to include account names. A
|
|
report closed as "not planned" or labelled `invalid` or `duplicate` is left out of the data.
|
|
|
|
## Secrets
|
|
|
|
- `ATLAS_BOT_TOKEN` (repository secret) lets the daily data update open and auto-merge its pull request
|
|
(`docs/REPO_SETTINGS.md`).
|
|
- `RAW_ARCHIVE_KEY` encrypts the raw store (the current and previous raw file of each source, which include the
|
|
register's rider names) in the Actions cache between daily runs. Without it nothing is archived.
|
|
- `REDDIT_CLIENT_ID` / `REDDIT_CLIENT_SECRET` let the daily update read the megathreads through the Reddit API. Tokens go in secrets only: never in a file, issue, chat or commit.
|