Skip to content

docs: rewrite templating concept page to remove duplicated recipes - #5808

Merged
ankatiyar merged 5 commits into
kedro-org:mainfrom
Shahzeb-DataEngineer:docs/templating-concept-page
Oct 15, 2026
Merged

ankatiyar merged 5 commits into
kedro-org:mainfrom
Shahzeb-DataEngineer:docs/templating-concept-page

Conversation

@Shahzeb-DataEngineer

Copy link
Copy Markdown
Contributor

Description

Reworks docs/configure/templating.md as a concept-only page, as requested in the issue. The page now explains what each templating mechanism is and when to reach for it, instead of reproducing the step-by-step YAML recipes that already live in how_to_use_templating.md.

Development notes

  • Kept the existing "Introduction to templating" and "Why use templating?" framing untouched.
  • Added a "Choosing a templating approach" decision table comparing variable interpolation, globals, runtime parameters, and custom resolvers.
  • Each mechanism section is a short conceptual explanation with a prominent cross-link to its how-to counterpart; all standalone YAML recipes were removed.
  • Checked outbound links from other docs pages (config_loader_migration.md, faq.md, AWS deploy pages, serving.md) — they already point to the recipe-oriented how_to_use_templating.md anchors, and configuration_basics.md keeps its concept-page link, so no link changes were needed.
  • Verified zensical build --strict passes with no issues and Vale reports 0 errors / 0 warnings / 0 suggestions on the edited page.

Related Issue

closes #5707

Developer Certificate of Origin

Signed-off-by: Shahzeb Ali [email protected]

Checklist

  • Read the contributing guidelines
  • Linked to a relevant GitHub issue
  • Signed off each commit with a DCO

Rework docs/configure/templating.md as a concept-only page per kedro-org#5707:
explain what each templating mechanism is and when to use it, add a
decision table, and cross-link each section to its how-to counterpart
instead of reproducing the YAML recipes from how_to_use_templating.md.

Closes kedro-org#5707.

Signed-off-by: Shahzeb Ali <[email protected]>
Copilot AI balanced review requested due to automatic review settings October 7, 2026 19:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@SajidAlamQB SajidAlamQB left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @Shahzeb-Ali-Web-Developer this looks great!

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔵 Needs a closer look

Issue #5707 requires sign-off from @lrcouto and @ElenaKhaustova, which the available reviews do not confirm.

0 open findings

🧠 Review effort: Balanced


Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.

@Shahzeb-DataEngineer

Copy link
Copy Markdown
Contributor Author

Fixed the lint failure — the decision table needed mdformat cell padding (pushed in ffa2d87). No content changes.

@Shahzeb-DataEngineer

Copy link
Copy Markdown
Contributor Author

Thanks Ankita for merging main in and fixing the lint — appreciate it!

@ankatiyar ankatiyar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @Shahzeb-DataEngineer LGTM

@ankatiyar
ankatiyar enabled auto-merge (squash) October 15, 2026 14:10
@ankatiyar
ankatiyar merged commit 80deafb into kedro-org:main Oct 15, 2026
6 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.

docs: reduce content overlap between templating.md (concept) and how_to_use_templating.md (how-to)

4 participants