Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a tip on YAML anchors to docs on dataset layers #2181

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add a tip on YAML anchors to docs on dataset layers #2181

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f9f382f
Give YAML anchors example in docs
yury-fedotov Nov 8, 2024
99a4ccb
Nest YAML block inside `tip`
yury-fedotov Nov 8, 2024
f9a7446
Remove closing ticks of the yaml section
yury-fedotov Nov 8, 2024
91c696d
Do not use `note` block
yury-fedotov Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/source/kedro-viz_visualisation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,17 @@

![](./images/pipeline_visualisation_with_layers.png)

Duplicated definitions like:

```yaml
metadata:
kedro-viz:
layer: raw
```

can be avoided by leveraging YAML's native syntax for anchors and aliases.

Check warning on line 205 in docs/source/kedro-viz_visualisation.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Kedro-viz.Spellings] Did you really mean 'YAML's'?

Raw Output:
{"message": "[Kedro-viz.Spellings] Did you really mean 'YAML's'?", "location": {"path": "docs/source/kedro-viz_visualisation.md", "range": {"start": {"line": 205, "column": 30}}}, "severity": "WARNING"}
See [this example from the Kedro docs](https://docs.kedro.org/en/stable/data/data_catalog_yaml_examples.html#load-multiple-datasets-with-similar-configuration-using-yaml-anchors).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Given that those are the docs of a separate project - I assume there's no way to link it other than through static URL?


## Share a pipeline visualisation

You can save a pipeline structure within a Kedro-Viz visualisation directly from the terminal as follows:
Expand Down
Loading