Remove deprecated notification cron job instructions#1453
Remove deprecated notification cron job instructions#1453
Conversation
musaabhasan
left a comment
musaabhasan
left a comment
There was a problem hiding this comment.
The direction makes sense for the current versioned docs: keeping deprecated cron instructions out of the latest page avoids operator confusion. I left one small usability note so operators who land here from search can still jump directly to the Ulmo instructions.
|
|
||
| Weekly digest - ``0 22 * * SUN tutor local run lms ./manage.py lms send_email_digest Weekly`` | ||
| If you are on an Ulmo system, please view this doc in the ``ulmo`` version for instructions on cron job configuration. | ||
|
|
There was a problem hiding this comment.
This preserves the fallback guidance, but it would be more useful as a direct versioned link to the Ulmo page rather than only saying to view the ulmo version. Operators often arrive from search or copied links and may not notice the version picker, so something like If you are on an Ulmo system, see the Ulmo notification setup page <https://docs.openedx.org/en/ulmo/site_ops/how-tos/enable_notifications.html>_ would keep the deprecated instructions discoverable without keeping them in the latest docs.
2 participants
@saraburns1 I noticed this when reviewing other docs. It's confusing to have documentation that is deprecated in the docs, especially without specifying what release the deprecation applies to.
Since we version the docs - picker in bottom right corner:
and the cron job instructions are on the Ulmo version (https://docs.openedx.org/en/ulmo/site_ops/how-tos/enable_notifications.html) we should just remove any instructions that are no longer relevant to the main trunk of the project.