search

kedro-org / kedro

Kedro is a toolbox for production-ready data science. It uses software engineering best practices to help you create data engineering and data science pipelines that are reproducible, maintainable, and modular.
https://kedro.org
Apache License 2.0
9.53k stars 879 forks source link

Add documentation about the combined use of `$globals` and `$runtime_params` #3706

Closed noklam closed 2 months ago

noklam commented 4 months ago

Description

Read https://github.com/kedro-org/kedro/issues/2531 for the full context.

There are many questions asked in the slack such as "how to override global with runtime parameters", we explicitly block this but we don't have the reason document.

The docs should document 2 things:

  1. The rationale of the design, WHY we block this
  2. How to do this in the preferred way (nested globals{xxx, {$runtime_param}))

Documentation page (if applicable)

(Try to search from the console see if you can find the section easily with keywords)

Possible solution

Summary #2531, the discussion was mostly documented already in the issue, we just need to make that available in docs.

datajoely commented 4 months ago

Another user touching this question

noklam commented 4 months ago

Make sure to read #2531 for the discussion.