Update compose file docs #2092
Update compose file docs #2092
Conversation
robertgzr
force-pushed
the
rgz/compose_file_version
branch
from
071322c
to
caba857
Compare
|
Do we actually support v2.4 fully? Why can't I put |
|
@klutchell hmm how did you try? |
|
@robertgzr yeah, I get |
|
@klutchell oohh yes definitely... see the hq issue for the list of todos |
robertgzr
force-pushed
the
rgz/compose_file_version
branch
from
caba857
to
87fd232
Compare
|
Should we wait to merge this until all of the related 2.4 support PRs have merged in the CLI, etc? |
robertgzr
force-pushed
the
rgz/compose_file_version
branch
2 times, most recently
from
85dfbce
to
3b88c85
Compare
robertgzr
added
the
versionbot/pr-draft
|
will remove the draft label when builder and cli changes are merged (deployed?) |
robertgzr
force-pushed
the
rgz/compose_file_version
branch
from
3b88c85
to
d27848b
Compare
|
robertgzr
force-pushed
the
rgz/compose_file_version
branch
from
d27848b
to
398181e
Compare
Occasionally users try to use fields that are supported by v2 but have different properties in version 3 (like long syntax for ports) and are surprised to get an error in response. Clarify that our support is based on version 2.4 Change-type: patch Signed-off-by: Robert Günzler <[email protected]>
robertgzr
force-pushed
the
rgz/compose_file_version
branch
from
398181e
to
0ad71be
Compare
|
@robertgzr Hey, what if we can automate this page to generate documentation as per the version we support? Can we do that if it is possible? |
|
@vipulgupta2048 I'm not sure about that. Right now the properties we do and don't support result from our code in compose-parse, with the actual implementation scattered between multibuild (for buildtime) and supervisor (for runtime) and sometimes there is partial support (like with maybe we can express the information that is needed here in a json schema form though? we already kind of use one... |
|
another thing that came to mind is where this documentation actually appears. It's not obvious to me why it's part of the supervisor reference, since it matters at build time as well (which is more cloud/cli doc) |
|
Oh wow, this got left behind quite a bit @robertgzr My automation request was a more of a suggestion, although maybe the engine should have a contract of what properties it supports to help list things out in a better way. |
|
@vipulgupta2048 you can check https://github.com/balena-io/balena-io/issues/2311#issuecomment-931564390, this work is stalled until I or somebody finds the time to investigate the breakage we get from using livepush with we should keep this PR open until those things are all completed I think... |
|
@balena-ci rebase |
ghost
force-pushed
the
rgz/compose_file_version
branch
from
0ad71be
to
3c9a46a
Compare
Occasionally users try to use fields that are supported by v2 but have
different properties in version 3 (like long syntax for ports) and
are surprised to get an error in response.
Clarify that our support is based on version 2.4
Change-type: patch
Signed-off-by: Robert Günzler [email protected]