Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite example configuration #687

Open
SpacemanPaul opened this issue Aug 9, 2021 · 1 comment
Open

Rewrite example configuration #687

SpacemanPaul opened this issue Aug 9, 2021 · 1 comment
Milestone

Comments

@SpacemanPaul
Copy link
Contributor

SpacemanPaul commented Aug 9, 2021

ows_cfg_example.py is poorly maintained, and does not reflect current best practice. The current file has a lot of now-unnecessary complexity from when it was the only documentation of configuration options.

Ideally:

  1. Made more minimalist and basic. Doesn't need to include every single config option. Users with advanced requirements should be referred to the documentation.
  2. A multi-file example directory, as per the layout of the current DEAus/DEAfrica config (but smaller and more minimal than either).
@SpacemanPaul SpacemanPaul added this to the Backburner milestone Aug 12, 2021
@SpacemanPaul SpacemanPaul changed the title Rewrite example documentation Rewrite example configuration Aug 31, 2021
@SpacemanPaul
Copy link
Contributor Author

Beefed up the disclaimer at the top of the file and added note to README to take it with a grain of salt.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant