PR#151 (link timing configuration) is not documented

[mcdemarco]

The link timing changes could use some documentation in the README, and possibly less surprising defaults in the config example file.

[lostcarpark]

It's clear that the current description is inadequate, and that the explanation of the WHEN setting should have been added to the README in #151.

I have opened #180 to expand the LINKS section. I would welcome any feedback on the change. Please let me know if I'm missed anything, or if you have any suggestions that would make it clearer.

Regarding the defaults, it makes sense to me that the live stream is only available during the item, as presumably before that, it will be an empty feed. Likewise, I would expect the recording will only make sense after the item ends. However, I'd welcome any thoughts on what defaults would come as less of a surprise.

[mcdemarco]

Part of the confusion was just that the behavior was unexpected as compared to last year. Also, the disabled link text without an explanation (say, that it's coming soon) could be something more friendly, like some boilerplate text about when the link will appear. This is more a code issue than a documentation change, though.

The description of "during" could use the details of when the link actually appears (I looked at the code at the time and IIRC it was 20 minutes before the start of the item), because "during" as stated would cause people to miss some of the item in the process of signing into Zoom or whatever.

[lostcarpark]

Those are some good ideas.

I would like to add configuration so to control when "during" starts (and ends).

I like the idea customising what's shown when a link is unavailable. For example a message like "Stream starts in X days/hours/minutes", and "Stream has ended", when it's over.

[olszowka]

Having a way for an end user to override and view the links makes it easier to confirm they are appearing correctly which I always like to do.

[mcdemarco]

Another timing suggestion also came up: only showing the links on the day of the item. (I would nickname it "day-of".)