docs
docs copied to clipboard
buildkite
SUP-1947: Add documentation and example of using YAML overrides
We've had a few customers get in touch about reducing duplication of code using YAML anchors to be able to template usage of Plugins for consistency but also wanting to change parts of the YAML anchor where required. So adding an short example of how to use YAML anchors and overriding mappings.
Hi @tomowatt , hope you don't mind me adding significant updates to this PR...
I thought this section of the docs was too useful to merge in without more/clearer explanations and examples.
I've done the following:
- Added a new sub-heading for your contribution (entitled "Overriding YAML anchors") to make it easier to find on a page. This is a subheading of the "Using YAML anchors ..." section, since your new valuable contribution is effectively an extension of this information.
- Updated some of the explanations to make it clearer as to what's going on with the syntax, mainly because I don't think all of our readers are YAML experts. I wasn't until I found that online parser site ^
- Our original way of defining what an alias in our docs was was misleading and essentially incorrect.
- Added expansion examples to both sections (the existing on simple YAML anchors and yours on overriding YAML anchors). Code examples explain everything!
Anyway, I'm happy for this to be merged now, and so please proceed to merge, unless there's anything I've done that's incorrect/needs modification or isn't clear.
Otherwise, I'll merge this tomorrow!
@gilesgas sorry for the delayed response but thank you very much for all that, it looks amazing!