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.

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

Documentation: Clarify blueprint extends, how it works and what is allowed and what not #1375

Open
renestalder opened this issue May 31, 2021 · 0 comments

Comments

@renestalder
Copy link

It's possible to reuse the status definitions (draft/listed etc) and that might be something everybody will ask themselves very early on. My experience with beginning with Kirby was exactly this: Create blueprints after blueprints and then wonder, how I can reuse frequently used definitions, and in this case, the status definition was the most obvious one I wanted to reuse.

I only looked this up today and found the answer by texnixe in the forum.
https://forum.getkirby.com/t/extends-and-reuse-for-status/17192/4

I believe it would make sense to extend the part of the documentation of "extending blueprints" with all possibilities that we have in extending from other files and also sometimes link back to this page from other parts of the documentation, e.g. when on the Page Blueprints documentation looking at "Statuses", mentioning how to reuse statuses for multiple pages.

Until now, it's not entirely clear to me how Kirby's extends work. Other tools also using YAML, also implement a form of extends, e.g. GitLab CI, but all those extends work differently, like some use relative paths to another YAML file including the file extension, others like Kirby have some form of namespace handling starting from the site director, e.g. fields/my-fields. For quite some time I thought there is a predefined way of how the blueprints in the site folders have to be for this to work. But now I believe, it just picks up whatever folder names you choose, e.g. extends: options/status. However, I didn't find this to be explained to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants