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

descriptions of environment variables #1280

Closed
CallumBaston opened this issue Jun 7, 2021 · 4 comments
Closed

descriptions of environment variables #1280

CallumBaston opened this issue Jun 7, 2021 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@CallumBaston
Copy link

Is your feature request related to a problem? Please describe.
Some of the possible environment variables mainly "DOZZLE_TAILSIZE" have no clear descriptions as to what they do.

Describe the solution you'd like
A simple description of what the variable does.

Additional context
I believe that for anyone new docker or Linux in general may have no idea what tail is or what it means in this context.

@CallumBaston CallumBaston added the enhancement New feature or request label Jun 7, 2021
@amir20
Copy link
Owner

amir20 commented Jun 7, 2021

That’s a good idea. I had planned to do it but we just had a baby. So it will have to wait a little.

IMO the best place to add description would in be in the CLI flags.

@CallumBaston
Copy link
Author

Congratulations Amir on your baby!
It is most likely better to add the descriptions for the CLI option of "--tailSize".

amir20 added a commit that referenced this issue Jun 11, 2021
@amir20
Copy link
Owner

amir20 commented Jun 11, 2021

@CallumBaston I quickly added some help messages in 3cfd03e. Send a PR if you think more clarification is needed.

@CallumBaston
Copy link
Author

Nope, Looks all good

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

No branches or pull requests

2 participants