docs: update documentation to OKF v0.1 format
This commit is contained in:
@@ -41,13 +41,15 @@ environment for the container to boot.
|
||||
`DEFAULTS` in `config.py` provides fallback strings that `apply_defaults`
|
||||
fills into the merged map **before** validation runs:
|
||||
|
||||
| Default key | Default value |
|
||||
|-----------------------|-------------------|
|
||||
| `VISIBILITY` | `public` |
|
||||
| `THROWNBACK_PREFIX` | `Throwback:` |
|
||||
| `MAX_RETRIES` | `3` |
|
||||
| `TZ` | `Europe/Berlin` |
|
||||
| `RUN_AT` | `09:00` |
|
||||
| Default key | Default value |
|
||||
|-----------------------|-------------------------------------------|
|
||||
| `VISIBILITY` | `public` |
|
||||
| `THROWNBACK_PREFIX` | `Throwback:` |
|
||||
| `MAX_RETRIES` | `3` |
|
||||
| `TZ` | `Europe/Berlin` |
|
||||
| `RUN_AT` | `09:00` |
|
||||
| `BLOG_REPO_URL` | `https://git.chaospott.de/Chaospott/site` |
|
||||
| `BLOG_DIR` | `blog` (resolved relative to `data_dir`) |
|
||||
|
||||
Because every required key carries a default, a freshly-initialised
|
||||
container can still boot to validate the scaffold, but the operator
|
||||
@@ -68,6 +70,8 @@ ideally `SITE_URL`) to make a real run.
|
||||
| `run_at` | `str` | `RUN_AT` |
|
||||
| `tz` | `str` | `TZ` |
|
||||
| `data_dir` | `Path` | Constant: `Path("/app/data")` |
|
||||
| `blog_repo_url` | `str` | `BLOG_REPO_URL` |
|
||||
| `blog_dir` | `Path` | `BLOG_DIR` resolved against `data_dir` |
|
||||
|
||||
# Validation Behaviour
|
||||
|
||||
@@ -80,6 +84,8 @@ problem joined with `"; "`. Validation covers:
|
||||
* `MASTODON_BASE_URL` and `SITE_URL` parse via `urllib.parse.urlparse`
|
||||
with an `http`/`https` scheme and a non-empty `netloc`.
|
||||
* `VISIBILITY` is one of `{"public", "unlisted"}` (`ALLOWED_VISIBILITY`).
|
||||
* `BLOG_REPO_URL` (optional, has default) parses via `urllib.parse.urlparse`
|
||||
with an `http`/`https` scheme and a non-empty `netloc` when present.
|
||||
* `TZ` resolves via `zoneinfo.ZoneInfo`.
|
||||
* `MAX_RETRIES` parses as a non-negative integer (rejects bools).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user