duffle.json is not well documented

cnabio / duffle

CNAB installer

https://duffle.sh

MIT License

375 stars 54 forks source link

duffle.json is not well documented #822

Closed itowlson closed 5 years ago

itowlson commented 5 years ago

The output bundle format (bundle.json) is well documented in the CNAB spec, but the Duffle build source format (duffle.json) doesn't seem to have anything similar. Could we provide a link to it from the README or something? (I would send a PR but I haven't been able to find the doc myself!)

(Specifically in this case I was trying to find out how to express parameters in duffle.json.)

itowlson commented 5 years ago

From the source code it looks like it's mostly the same as bundle.json except for the invocationImages section?

glyn commented 5 years ago

From the source code it looks like it's mostly the same as bundle.json except for the invocationImages section?

That sounds right to me. Why not submit a PR along those lines?

itowlson commented 5 years ago

Yes - if that is correct then I will try to put together a docs PR. Thanks!

itowlson commented 5 years ago

Mwahahahaha... I have tricked @squillace into volunteering to write some docs! Freedom!

squillace commented 5 years ago

Evil

jeremyrickard commented 5 years ago

@squillace @itowlson I think this is essentially a duplicate of #609. When this documentation is written can you please reference both issues in the PR?

astrieanna commented 5 years ago

If they're duplicates, would it make sense to close one of the issues now?

jeremyrickard commented 5 years ago

Closed as duplicate of #609