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.

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

cc: document crontab trigger #59

Merged
merged 10 commits into from
Dec 3, 2024
Merged

Conversation

SoggySaussages
Copy link
Contributor

Documents the new crontab trigger, linking robfig's docs, Wikipedia, and outlining some examples of common schedules.

Terms

Signed-off-by: SoggySaussages [email protected]

Copy link
Collaborator

@jo3-l jo3-l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a general comment, I think we should link to https://crontab.guru/ or a similar tool somewhere in this documentation.

content/docs/custom-commands/commands.md Outdated Show resolved Hide resolved
content/docs/custom-commands/commands.md Outdated Show resolved Hide resolved
content/docs/custom-commands/commands.md Outdated Show resolved Hide resolved
content/docs/custom-commands/commands.md Outdated Show resolved Hide resolved
content/docs/custom-commands/commands.md Outdated Show resolved Hide resolved
content/docs/reference/templates/functions.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@jo3-l jo3-l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry to nitpick, but there are some suggestions remaining from my last review. We should be good to merge after.

content/docs/custom-commands/commands.md Show resolved Hide resolved
content/docs/custom-commands/commands.md Outdated Show resolved Hide resolved
@SoggySaussages
Copy link
Contributor Author

Sorry to nitpick, but there are some suggestions remaining from my last review. We should be good to merge after.

I’m not seeing what’s missing from your last review apart from a general comment, what are the unresolved suggestions from your last review?

Copy link
Collaborator

@jo3-l jo3-l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the confusion, I just meant the reference to crontab.guru and the (not fully realized) suggestion to copy the documentation from robfig/cron. This LGTM now, but I will wait for @l-zeuch for any final thoughts and merge.

Copy link
Collaborator

@l-zeuch l-zeuch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just two stylistic remarks, the rest looks good.

content/docs/custom-commands/commands.md Show resolved Hide resolved
Comment on lines 349 to 354
Channel (**2**) specifies a channel to run the command in. The response, if any, will be sent to this channel.

Excluding hours and/or weekdays (**3**) prevents the command from triggering during those hours or weekdays. **This uses
UTC time**, not your local timezone.

You must specify a channel to run time-based commands in even if the command doesn't output a message.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be moved to the rest of the image caption at the start of this section.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’m not sure I understand what you’re asking for.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SoggySaussages I cannot see any change addressing this comment--did you perhaps forget to push your changes or publish your response?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh sorry, maybe you can’t see my response. I replied to this saying “I’m not sure I understand what you’re asking for,” which still stands.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to have this section (after the callout and until the next heading) moved further up, before the table explaining how a cron expression is structured.

As it stands, we have a screenshot of the page, with its appropriate caption, then go to great lengths of explaining a single marked thing in that screenshot (the cron expression labelled 1), then have more references to the image. This makes this section awkward to read--a reader would have to scroll back up for the visual reference the image is supposed to provide.

Though these additional fields are quickly explained, I'd rather have them at the top with the description of the cron expression, and only after the image is fully describe we explain how to construct a cron expression. That way, we have the image closer to the text that is describing it, eliminating or reducing the need to scroll back up.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's done.

@SoggySaussages
Copy link
Contributor Author

SoggySaussages commented Dec 3, 2024

Sorry I’m just realizing a bunch of comments were left pending in s review instead of posted as individual comments, my apologies. I’m not sure how I did that. Most of these comments I just published are a few days old.

@l-zeuch l-zeuch merged commit e6d0e03 into botlabs-gg:master Dec 3, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants