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.

Sign up for GitHub

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

Jump to bottom

Update the explanation of the lockdown period relative date. #378

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update the explanation of the lockdown period relative date. #378

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions _documentation/configurations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,13 @@ You can deactivate that feature by setting the value to 0.

## Lockdown period

- `Lockdown period start` - a PHP date-format string `relative to now` and you will likely want to configure a start of a month like `first day of last month 00:00:00` or `first day of -2 month 00:00:00`
- `Lockdown period end` - a PHP date-format string `relative to now` and you will likely want to configure the end of a month like `last day of last month 23:59:59`, `last day of -2 month 23:59:59` or `first day of this month 00:00:00`
- `Lockdown period start` - a string of [PHP relative datetime format](https://www.php.net/manual/en/datetime.formats.php#datetime.formats.relative)
- You will likely want to configure a start of a month like `first day of last month 00:00:00` or `first day of -2 month 00:00:00`
- `Lockdown period end` - a string of [PHP relative datetime format](https://www.php.net/manual/en/datetime.formats.php#datetime.formats.relative)
- You will likely want to configure a start of a month like `last day of last month 23:59:59`, `last day of -2 month 23:59:59` or `first day of this month 00:00:00`
- `Time zone` - the timezone will be used to calculate the dates (might be important if you have users across multiple timezones, if empty the timezone of the current user is used
- `Lockdown grace period end (PHP relative date to lockdown period end)` - relative to the lockdown end (the end date will always be appended, but it could still be overwritten by using the `of` modifier), most users will likely want to use a relative period like `+12 hours`, `+10 days` or `+3 weeks`
- `Lockdown grace period end` - a string of [PHP relative datetime format](https://www.php.net/manual/en/datetime.formats.php#datetime.formats.relative) that will be applied to the `Lockdown period end`
- You will likely want to configure a relative period like `+12 hours`, `+10 days` or `+3 weeks`

The lockdown period (if activated) will prevent your users from changing timesheet records in the past.

Expand Down