Document examples of valid lib.timezone setting values

Bug #1817332 reported by Remington Steed on 2019-02-22
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Evergreen
Low
Unassigned
3.2
Undecided
Unassigned

Bug Description

As mentioned in bug 1752753, we need better documentation for valid inputs for the lib.timezone setting. Eventually, the input widget itself can help with this (see bug 1754364), but until then it seems we need:

- A better settings description that provides a few common examples
- A complete reference, linked from the description and/or from the docs

Branch coming soon to address both of these.

Remington Steed (rjs7) wrote :

Here's a simple branch which updates the setting description with examples and a link to Wikipedia. Upgrade script is included.

https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/rsteed/lp1817332_add_example_to_timezone_setting

Changed in evergreen:
milestone: none → 3.3-beta1
tags: added: pullrequest
Changed in evergreen:
importance: Undecided → Low
Jane Sandberg (sandbej) wrote :

I like it -- thanks, Remington. I think that it's important to include an example with an underscore too (e.g. Africa/Addis_Ababa or America/Los_Angeles). Otherwise users might not know they need the underscore. Various things break if you try entering one of these with a space instead of an underscore!

Changed in evergreen:
milestone: 3.3-beta1 → 3.3-rc
Changed in evergreen:
milestone: 3.3-rc → 3.3.1
Changed in evergreen:
milestone: 3.3.1 → 3.3.2
Galen Charlton (gmc) wrote :

I've pushed a branch that signs off on the original patch and adds a follow-up to both implement Jane's suggestion and avoid overwriting any custom description of the setting that may have been added.

user/gmcharlt/lp1817332_lib_timezone_doc
https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/gmcharlt/lp1817332_lib_timezone_doc

I note that when we get around to writing an Angular library settings editor, it may have to be explicitly taught to render (safe) HTML in the org unit setting type descriptions.

tags: added: signedoff
Changed in evergreen:
status: New → Confirmed
Bill Erickson (berick) on 2019-05-24
Changed in evergreen:
assignee: nobody → Bill Erickson (berick)
Bill Erickson (berick) wrote :

Looks good. Merged to 3.2 and above. Thanks, All.

Changed in evergreen:
assignee: Bill Erickson (berick) → nobody
status: Confirmed → Fix Committed
Changed in evergreen:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers