Skip to content

docs(event-scheduler): describe the form users actually get - #686

Open
rad-pat wants to merge 1 commit into
mainfrom
sc-23385-event-scheduler-doc
Open

docs(event-scheduler): describe the form users actually get#686
rad-pat wants to merge 1 commit into
mainfrom
sc-23385-event-scheduler-doc

Conversation

@rad-pat

@rad-pat rad-pat commented Sep 7, 2026

Copy link
Copy Markdown
Member

Companion to PlaidCloud/PlaidClient#2237, which reworks the Event Scheduler form's layout. Reading the shipped screen alongside this page turned up that the page still documents the YAML form the native one replaced.

Story: https://app.shortcut.com/plaidcloud/story/23385

What was wrong

Three things on this page name UI that does not exist:

  • a Limit Running section (commented out in job.yaml);
  • an Event Schedule tab with a Schedule type choice;
  • a workday schedule using holiday calendars — also commented out in the backend (plaid/app/analyze/tools/cron/job_form.py), so it is not a client-only gap.

The steps under "To use the classic schedule approach" and "To set the workflow to run using the workday schedule approach" therefore could not be followed at all. The Description promised the workday/holiday-calendar capability too.

What changed

The create section now describes the form as shipped — Details (Name, Memo, the Activate checkbox, Project and Workflow, with the note that the workflow list follows the project and that both are fixed after creation), Timezone (the UTC offset range, and that it defaults to UTC rather than local time), and the five schedule fields with what each needs before the event will save. Four worked examples for the common cadences replace the tab-by-tab instructions.

Pausing now leads with Disable Selected / Enable Selected, which is the quicker route and was not mentioned at all; the edit-and-untick alternative stays, with the checkbox's real label rather than "Active".

The diagram's two schedule lines, its aria-label and its caption drop the workday/holiday wording.

Deliberately not documented

How Days of Month and Days of Week combine when both are restricted. The schedule preview (cron_converter) and the Kubernetes CronJob that actually fires the event (robfig/cron, Vixie semantics) disagree on this, so there is no single correct answer to write down yet. Filed separately — see the story comment on sc-23385.

Testing

astro build clean locally — 1656 pages, no MDX or frontmatter errors.

🤖 Generated with Claude Code

https://claude.ai/code/session_01ENnDDucffJjNsR8ynj1VsT

The page still documented the YAML form: a "Limit Running" section, an
"Event Schedule" tab, and a "Schedule type" choice between a classic and
a financial workday schedule with holiday calendars. None of that is in
the shipped screen, and the workday half is commented out on the backend
too, so the steps could not be followed at all.

Replaced with what the form has — Details, Timezone, and the five
schedule fields — plus what each one needs before the event will save,
and worked examples for the common cadences. Pausing now leads with the
Enable/Disable Selected buttons, which is the quicker route and was not
mentioned; the checkbox alternative keeps its real label.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01ENnDDucffJjNsR8ynj1VsT
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
plaidcloud-docs 3c46a33 Commit Preview URL

Branch Preview URL
Sep 07 2026, 02:50 PM

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.

1 participant