Skip to content

add more detail to the environment-variable docs #37

@oregonpillow

Description

@oregonpillow

I think the environment-variables could be improved in both format and content.

At a minimum i feel that each variable in the table should additionally have a type specified (bool, string, int) and at least 1 valid example. This is especially true for the datetime formatting.

For example:

  • what format do i use to specify APP_TIMEZONE ? Docs say nothing about this.
  • CHART_DATETIME_FORMAT , DATETIME_FORMAT : a couple of common examples would probably satisfy 99% of use cases and save users from wading through PHP docs
  • DISPLAY_TIMEZONE: I'm assuming this is bool or should it be string?

i think clearer tables would look something like this (or contain the same information in different format):

Example1

Name Required Description Example
SPEEDTEST_SCHEDULE
str
Cron expression used to run speedtests on a scheduled basis.
Default: None
* 1 * * *

Example2

Name Description
SPEEDTEST_SCHEDULE
str
Cron expression used to run speedtests on a scheduled basis.
Default: None
Example: * 1 * * *
Required: ✅

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions