From 52d20630e401784c1ddc1a77402e736d3dc2f372 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bruno=20Par=C3=A9-Simard?= Date: Fri, 26 Jan 2024 12:04:38 -0500 Subject: [PATCH] Update the explanation of the lockdown period relative date. See #376 --- _documentation/configurations.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/_documentation/configurations.md b/_documentation/configurations.md index cdd8c53b8..358c4eef3 100644 --- a/_documentation/configurations.md +++ b/_documentation/configurations.md @@ -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.