Validate examples and clean up roadmap
This commit is contained in:
@@ -22,6 +22,8 @@ files. Environment-variable configuration is not implemented.
|
||||
|
||||
## Minimal Config
|
||||
|
||||
See [examples/minimal-config.yml](../examples/minimal-config.yml).
|
||||
|
||||
```yaml
|
||||
weather_api:
|
||||
base_url: https://weather.api.example.com/
|
||||
@@ -102,3 +104,12 @@ snapshot exists and a threshold is crossed.
|
||||
|
||||
Configuration files should not contain secrets. The current Weather API and
|
||||
Scriptorium integration settings do not require secret fields.
|
||||
|
||||
## Maintained Examples
|
||||
|
||||
- [examples/minimal-config.yml](../examples/minimal-config.yml): smallest
|
||||
useful config for generation and fetching.
|
||||
- [examples/config.yml](../examples/config.yml): production-oriented config
|
||||
covering implemented fields.
|
||||
|
||||
Both example files are loaded by the config test suite.
|
||||
|
||||
Reference in New Issue
Block a user