pacificclimate / weather-anomaly-tool

0 stars 0 forks source link

Store help pages in separate markdown files #105

Closed rod-glover closed 1 month ago

rod-glover commented 2 months ago

@Nospamas said

I do wonder if it would be more appropriate to keep this information within .md files in the repo, Config is useful where environment or deployment changes but it strikes me that this help information is unlikely to change on a per-deployment basis.

If moved to dedicated files we'd have better syntax highlighting, less yaml pain and less need to deploy changes to this separately from the docker image.

I'm not convinced these are not effectively config -- they lie in the grey zone of resource files -- but they are certainly better located in separate markdown files, with paths configured in config.yaml.