Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc to show how to use broker via vendor #940

Merged
merged 2 commits into from May 10, 2018
Merged

doc to show how to use broker via vendor #940

merged 2 commits into from May 10, 2018

Conversation

jmrodri
Copy link
Contributor

@jmrodri jmrodri commented May 9, 2018

No description provided.

@openshift-ci-robot openshift-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 9, 2018
@jmrodri jmrodri added the docs label May 9, 2018

The Automation Broker implements the Open Service Broker API. As a broker it
provides quite a bit of behavior that might want to be used by other broker
authors, for example, asynchronous job support, ...
Copy link
Member

Choose a reason for hiding this comment

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

nit: asynchronous job support, etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

addressed

## Vendoring

To get the Automation Broker as a dependency, here is an example of the
`Gopkg.toml` used by `dep`. You can use any of the types supported by the `dep`
Copy link
Member

Choose a reason for hiding this comment

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

Here is an excerpt from Gopkg.toml used by golang/dep that adds the Automation Broker as a dependency.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

addressed

## Extending

Once we have the dependency installed in our project, how do we use it? The
Automation Broker will do most if not all of the heavy lifting, but allows the
Copy link
Member

Choose a reason for hiding this comment

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

nit: will do most, if not all, ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

addressed

@jmrodri jmrodri merged commit 93af520 into master May 10, 2018
@jmrodri jmrodri deleted the add-library-doc branch May 31, 2018 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants