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

Some documentation and example config values are missing #489

Closed
zneix opened this issue Jun 10, 2023 · 2 comments
Closed

Some documentation and example config values are missing #489

zneix opened this issue Jun 10, 2023 · 2 comments
Assignees

Comments

@zneix
Copy link
Collaborator

zneix commented Jun 10, 2023

With the addition of few new config options, including, but not limiting to log-level, log-development, etc. were never mentioned in CHANGELOG.md nor in config.yaml file. Possible values for these and possibly other options were never disclosed anywhere either.

I'm aware that missing changelog entries are something that can't really be undone now, but I'd love to have some clearer rule(s) for contributors or just say right here my thought as to when and what to include there - any change to config options, be it rename, addition or deletion should be carefully explained (or at least be mentioned and explained within config.yaml file / --help output).

@pajlada
Copy link
Member

pajlada commented Jun 11, 2023

I believe those two PRs will resolve the missing documentation piece.

For future changes, I'll just make sure the changelog entry CI isn't overridden - the v2.0.0 release was a bit crazy

@zneix
Copy link
Collaborator Author

zneix commented Jun 11, 2023

Oh I was not aware of issues with overriding documentation, that's understandable. These two PRs explain exactly what one would want to know, so I'm good with that, thank you for your help.

@pajlada pajlada closed this as completed Jun 11, 2023
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

2 participants