Skip to content

feat: add 'Use Variables to Personalize Your Tutorials' meta tutorial (#2819) - #10

Merged
jung-thomas merged 1 commit into
mainfrom
feat/meta-tutorial-variables-2819
Oct 17, 2026
Merged

jung-thomas merged 1 commit into
mainfrom
feat/meta-tutorial-variables-2819

Conversation

@jung-thomas

Copy link
Copy Markdown
Contributor

Closes sap-tutorials/tutorials-ims#2819.

Public-catalog mirror of sap-tutorials/meta-tutorials-Contribution#13.

Adds a new meta tutorial teaching authors the tutorial variables feature shipped in tutorials-ims#2818 (implements tutorials-ims#2811): the variables: frontmatter block and {{var:NAME}} body tokens that let a reader type a per-person value once and have it substituted live into prose, inline code, and copy-pasteable fenced code blocks.

Slug: use-variables-in-tutorials

What it covers

  • Why variables exist (the manual-XXX-everywhere problem) and when not to use one
  • Declaring a variables: block — every field and the hard-fail validation rules
  • Referencing {{var:<name>}} in prose, inline code, and fenced code blocks
  • The optional default: { from, pattern } identity-regex pre-fill (allowlist: email, id, givenName, familyName)
  • Client-side persistence + mission carry-over semantics (by variable name)
  • A pre-publish verification checklist

Self-demonstrating

Declares one real variable, groupNumber, and uses {{var:groupNumber}} throughout prose, inline code, and a bash block — the reader sees their own value substituted live while learning the feature.

Validation

Ran through the actual composeTutorial parser (the real build path): accepts cleanly, 7 steps, 1 variable parsed with correct schema, 0 unwrapped live tokens; the 6 literal {{var:<name>}} occurrences are intentional syntax examples (non-matching metavariable). Single H1, 7 H3 steps, <!-- description --> present, LF line endings.

🤖 Generated with Claude Code

@sap-tutorials-builder

Copy link
Copy Markdown

Content (1)

  • tutorials/use-variables-in-tutorials/use-variables-in-tutorials.md:1 — No step headings found (expected at least one '## ' heading that is not 'You will learn' or 'Prerequisites')

Checked e08e3fc • notify-only, does not block merge

@jung-thomas

Copy link
Copy Markdown
Contributor Author

Canonical authoring/QA source PR: sap-tutorials/meta-tutorials-Contribution#13

@jung-thomas
jung-thomas merged commit f3db887 into main Oct 17, 2026
1 check passed
@jung-thomas
jung-thomas deleted the feat/meta-tutorial-variables-2819 branch October 17, 2026 22:10
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.

New Meta Tutorial to showcase the new variables replacement feature

1 participant