Skip to content

docs: add DocC tutorial for pipeline capabilities#97

Merged
albertodebortoli merged 1 commit into
mainfrom
pipelines-docc-tutorial
Jun 20, 2026
Merged

docs: add DocC tutorial for pipeline capabilities#97
albertodebortoli merged 1 commit into
mainfrom
pipelines-docc-tutorial

Conversation

@albertodebortoli

@albertodebortoli albertodebortoli commented Jun 20, 2026

Copy link
Copy Markdown
Member

Description

  • Adds a RunningPipelines.tutorial DocC tutorial covering the pipeline engine introduced in recent releases.
  • Four sections walk through: creating a pipeline YAML file, running it with luca run, adding parameters and conditional tasks, and previewing execution with --dry-run.
  • Includes all step-by-step resource files (.yml, .sh, .txt) referenced by the tutorial steps.
  • Registers the new "Running Pipelines" chapter in Luca.tutorial.
  • No related issue.

Type of Change

  • Documentation

How Has This Been Tested?

  • Manually tested locally (describe)

Previewed with xcrun docc preview at http://localhost:8080/tutorials/luca — all four sections render correctly, code steps progress as expected.

Checklist

  • Documentation updated (README / comments)
  • PR title follows conventional style (optional)

Breaking Changes?

  • No

Additional Notes

The @Chapter directives lack @Image children — this is a pre-existing condition on all chapters in the catalog, not introduced by this PR.

Adds a RunningPipelines tutorial covering pipeline file creation, luca run,
parameters, conditional tasks, and dry run preview. Includes all step-by-step
resource files and registers the new chapter in Luca.tutorial.
@albertodebortoli albertodebortoli added this to the 0.22.0 milestone Jun 20, 2026
@albertodebortoli albertodebortoli added the documentation Improvements or additions to documentation label Jun 20, 2026
@albertodebortoli albertodebortoli marked this pull request as ready for review June 20, 2026 19:19
@albertodebortoli albertodebortoli merged commit 3f6ca98 into main Jun 20, 2026
3 checks passed
@albertodebortoli albertodebortoli deleted the pipelines-docc-tutorial branch June 20, 2026 19:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant