Update Juju2 metadata docs. #1100

Merged
merged 4 commits into from Jul 12, 2016

Conversation

Projects
None yet
4 participants
Contributor

wwwtyro commented May 13, 2016

Adds documentation for resources, payloads, extra-bindings, series, terms, and min-juju-version. #1079

src/en/authors-charm-metadata.md
@@ -104,5 +104,43 @@ and whether it's designed for deployment as a
- if the charm is subordinate, it must contain at least one `requires`
relation with container scope.
+`resources` defines ???
@wwwtyro

wwwtyro May 13, 2016

Contributor

Could use some clarification on the resources field.

src/en/authors-charm-metadata.md
+ description: example resource
+```
+
+`payloads` defines ???
@wwwtyro

wwwtyro May 13, 2016

Contributor

Could use some clarification on the payloads field.

src/en/authors-charm-metadata.md
+Other available fields are:
+
+ - `format` ???
+ - `categories` ???
@wwwtyro

wwwtyro May 13, 2016

Contributor

Could use some clarification on the format and categories fields.

@marcoceppi

marcoceppi May 13, 2016

Owner

format is for historical reasons and is not used anymore. categories have since become tags

@@ -104,5 +104,45 @@ and whether it's designed for deployment as a
- if the charm is subordinate, it must contain at least one `requires`
relation with container scope.
+`resources` allows you to add a blob that your charm can utilize.

@pmatulis pmatulis added eco-team and removed eco-team labels May 20, 2016

src/en/authors-charm-metadata.md
+
+Endpoint names are strings and must not match existing relation names from
+the Provides, Requires, or Peers metadata sections. The values beside each
+endpoint name must be left out (i.e. "foo": <anything> is invalid).
@chuckbutler

chuckbutler Jun 29, 2016

Collaborator

Brackets in output do not render in the computed markdown document. Either remove them, or set this to &lt; &gt;

Collaborator

chuckbutler commented Jun 29, 2016

One minor nit otherwise LGTM 👍

Contributor

wwwtyro commented Jul 5, 2016

@chuckbutler how now, brown cow?

Collaborator

chuckbutler commented Jul 5, 2016

👍 LGTM

Collaborator

chuckbutler commented Jul 12, 2016

@pmatulis i think we're good here with your blessing.

Contributor

pmatulis commented Jul 12, 2016

🍬 Thank you everybody 🍬

@pmatulis pmatulis merged commit 8a63a56 into juju:master Jul 12, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment