Skip to content
This repository has been archived by the owner on May 3, 2022. It is now read-only.

Clarify what duffle is intended for #739

Merged
merged 3 commits into from May 6, 2019

Conversation

carolynvs
Copy link
Contributor

Duffle is the reference implementation of the spec. We should point people to the the community tools if they want to build new bundles so that they don't assume that duffle is the official tool for that, and get frustrated when it's super hard. 馃榾

We keep a list of community run projects, like Docker Apps and Porter, that we can point to so that people can find a tool to fit their needs. I have an open PR to add Docker Apps to that page, but would like a review from someone at Docker first before I merge it. Maybe @silvin-lubecki can take a look?

Duffle is the reference implementation of the spec. Point people to some of the
community tools if they want to build new bundles.
@technosophos
Copy link
Member

I am not sure I like the way this is phrased. I don't feel like we should say that we don't recommend using Duffle for the things that it is built to be able to do.

It is fine with me if you state that Duffle is a low-level tool designed to show how the specification should work, and that there are other tools that make bundle building easier. But it is not good to imply that one should not use the tool (or even imply that).

To that point, if Duffle is that bad at building bundles, it really should be fixed. (Though the feedback I got was that it was the documentation that was misleading.)

Copy link
Member

@technosophos technosophos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds great.

README.md Outdated

The community has created implementations of the CNAB spec with
[opinionated takes on authoring bundles][cnab-tools]. Some even use Duffle's
[libraries][cnab-go] to handle the CNAB implementation. If you want to make your own CNAB tooling, that is a great place to start!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't the link libraries point to the libraries list on cnab.io, as there are multiple libraries (rust, python, .net) other than go?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops! Yes, thank you good catch!

@carolynvs carolynvs merged commit 5e15f8b into cnabio:master May 6, 2019
@carolynvs carolynvs deleted the when-to-use-duffle branch May 6, 2019 19:54
@ghost ghost removed the review label May 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants