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

Improve docs #183

Open
ctcjab opened this issue Dec 4, 2024 · 0 comments
Open

Improve docs #183

ctcjab opened this issue Dec 4, 2024 · 0 comments

Comments

@ctcjab
Copy link

ctcjab commented Dec 4, 2024

The README appears to be the only documentation for this software, and doesn't currently cover some key use cases.

(For example, I just tried supercronic for the first time and am seeing the warning "process reaping disabled, not pid 1" logged, but there is no mention in the docs of process reaping, the implications of having it disabled, what to do to enable it, etc. There is an unrelated mention that "Supercronic needs to be PID 1" to enable supercronic to reload crontabs when appropriate signals are delivered to the container, but again, no docs on or example of how to do that.)

Proposing this ticket to track improving the docs, ideally with a comprehensive description of supercronic's features, usage, and configuration available on a dedicated docs site, or at least in the README.

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