The previous format seems to have been a mixture of the format accepted
by most Markdown parsers, and the format Org Mode for Emacs likes.
Anyhow, we breathe Markdown.
Signed-off-by: Hidde Beydals <hello@hidde.co>
This mostly adapts the material in the v1alpha1 spec explainer doc to
the different structure of the v1alpha2 types.
Signed-off-by: Michael Bridgen <michael@weave.works>
- Add optional `path` field to `spec.update`, defaults to the git repo root
- Restrict updates to the specified `spec.update.path`
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
As a YAML example, this also shows the YAML/JSON field names. Since
field names are different in the Go types, it can be confusing.
Signed-off-by: Michael Bridgen <michael@weave.works>
The message template is used in YAML files, not in go code. I've also
explained up-front that it's a text template -- something not
mentioned to this point.
Signed-off-by: Michael Bridgen <michael@weave.works>
This explains the data available to the commit message template in the
API guide. While writing it, I realised it could be made more
convenient, so:
- mask external types by embedding them
- make the most useful parts of an image ref available using a
wrapper struct and interface
Signed-off-by: Michael Bridgen <michael@weave.works>
This commit updates the generated and written API refs to account for
the new update strategy types.
Signed-off-by: Michael Bridgen <michael@weave.works>
Hidde Beydals
Michael Bridgen
Stefan Prodan
LWJ
Jason Raimondi