eric/distributor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

Clean up documentation consistency

Browse Source
This commit is contained in:
Eric Rakestraw
2026-05-31 04:10:14 +00:00
parent 14444c152b
commit 783d094007
7 changed files with 43 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/config.md
View File

@@ -10,7 +10,7 @@ If `--config` is omitted, `run` uses:
/usr/local/etc/distributor/config.yml
```
Config parsing rejects unknown YAML fields. The current executable backend support is local only. SSH and S3 config fields are accepted by config validation, but runtime execution for those backends is not implemented.
Config parsing rejects unknown YAML fields. The current executable backend support is local only. SSH and S3 config fields are accepted by config validation, but runtime execution for those backends is unavailable.
## Minimal Local Config
@@ -105,8 +105,8 @@ Destination:
Accepted backend names:
- `local`: executable; requires `path`.
- `ssh`: config validation only; execution is not implemented.
- `s3`: config validation only; execution is not implemented.
- `ssh`: config validation only; execution is unavailable.
- `s3`: config validation only; execution is unavailable.
Publish policy:
@@ -141,7 +141,7 @@ Do not put literal secrets in config files. S3 credentials may name environment
- `credentials.access_key_id_env`
- `credentials.secret_access_key_env`
S3 execution is not implemented yet; these fields are accepted so config shape can be validated ahead of backend implementation.
S3 execution is unavailable; these fields are accepted so config shape can be validated.
## Examples