Skip to content

Add Orchestration Docs - #26

Merged
MiConnell merged 5 commits into
masterfrom
orchestration-docs-updates
Jun 6, 2026
Merged

Add Orchestration Docs#26
MiConnell merged 5 commits into
masterfrom
orchestration-docs-updates

Conversation

@MiConnell

Copy link
Copy Markdown
Contributor

This PR adds a page for the new orchestration functionality in FlexIt. Should wait until release 2026.06.001 before merge.

MiConnell added 5 commits June 1, 2026 17:28
Covers step types, step properties (When/On Failure/Disabled),
parameter declaration + propagation, [[@name]] substitution,
the Insert Parameter editor affordances, Run Status modal and
drill-through, scheduling with overlap policies, and common
patterns. Slotted under Data and Modeling between ETL and
Data Ingestion.
Rewrite Getting Started to match the actual UI: top-level
Orchestration sidebar item with five tabs (Jobs, Pipelines, Run
History, DAG, Overview). Replace stray "Administration > Pipelines",
"pipeline list", and "Run-Now" references with the real tab names.
Consolidate the redundant "Run-Now and Manual Triggers" heading
into "Manual Triggers". History section now points readers at the
Run History tab and notes it spans both jobs and pipelines.
Adds eight images to static/img/orchestration/ and inline references
in orchestration.md at the spots previously marked with SCREENSHOT
comments — Jobs tab list, Pipelines design view with step properties,
parameter declaration + filled values, SQL editor with placeholders
and the param prompt modal, Run History list + run results, and the
Schedule modal with overlap policies. Also fixes a markdown table cell
where the pipe in the {{ region_code | lower }} example broke the row;
now uses HTML entities so the literal pipe renders inside the inline
code without escaping artifacts.
Adds a Views section just before Permissions, with subsections covering
the two tabs that were previously only mentioned in the Getting Started
bullet list. Each subsection explains the tab's purpose and includes
"use this when" bullets so readers can tell at a glance whether they
should be on that tab. Two screenshots — orchestration_dag.png and
orchestration_overview.png — anchor the prose.
Adds a blockquote at the top flagging that orchestration features
(pipelines, the Orchestration sidebar entry, Run History / DAG /
Overview tabs, and pipeline-aware parameter propagation) require
2026.06.001 or later. Links to new.md so readers on older installs
know where to find the upgrade context. Matches the > **Note**
callout style already used in administration.md and dashboard.md.
@MiConnell
MiConnell requested a review from ataft June 4, 2026 00:36
@MiConnell
MiConnell merged commit f6ffa00 into master Jun 6, 2026
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.

2 participants