Github user geomacy commented on the pull request:
https://github.com/apache/brooklyn-docs/pull/49#issuecomment-214712076
My thought on this is that the behaviour we are describing here, and I
don't just mean the newly added stuff in this PR, is complicated enough that we
should expand the text to at least include examples of each of the
possibilities. At minimum I'd say the new material needs illustration.
E.g.
Entries can be URL to another catalog file to include, inheriting the meta
from the current hierarchy. For example:
```
brooklyn.catalog:
displayName: Foo
brooklyn.libraries:
- http://some.server.or.other/path/my.jar
items:
- classpath:my-catalog-entries.bom
- id: use-from-my-catalog
item:
type: some-type-defined-in-my-catalog-entries
```
In this case a jar file is added as a library, and then catalog items are
added from the "my-catalog-entries.bom" file it contains, followed by an
additional item that makes use of the definitions in the included file.
And similarly for the include case. We should cover the various supported
scenarios.
A question - do we really need the "include" keyword? Does the use of a URL
as the item not do the same thing? If we can avoid "include" it might avoid
confusion as to whether to use it or not.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
