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

Commit

Permalink
update docs around examples directory
Browse files Browse the repository at this point in the history
Signed-off-by: Vaughn Dice <vadice@microsoft.com>
  • Loading branch information
vdice committed Feb 26, 2020
1 parent 36516ae commit 270e3ba
Show file tree
Hide file tree
Showing 8 changed files with 7 additions and 60 deletions.
11 changes: 4 additions & 7 deletions README.md
@@ -1,5 +1,5 @@
# Duffle: The CNAB Installer
![Build Status](http://badges.technosophos.me/v1/github/build/deislabs/duffle/badge.svg?branch=master)
![Build Status](http://badges.technosophos.me/v1/github/build/cnab/duffle/badge.svg?branch=master)


Duffle is the reference implementation of the [CNAB specification][cnab]. It
Expand Down Expand Up @@ -29,9 +29,6 @@ Learn more about about CNAB and Duffle, check out our [docs](docs/README.md).
/home/janedoe/.duffle/credentials
==> The following new files will be created:
/home/janedoe/.duffle/repositories.json
==> Generating a new secret keyring at /home/janedoe/.duffle/secret.ring
==> Generating a new signing key with ID janedoe <janedoe@computer>
==> Generating a new public keyring at /home/janedoe/.duffle/public.ring
```

3. Build and install your first bundle (you can find the `examples` directory in this repository):
Expand Down Expand Up @@ -72,7 +69,7 @@ Learn more about about CNAB and Duffle, check out our [docs](docs/README.md).
---> Running in d2294cc8b7fd
---> 69abe3476d43
Successfully built 69abe3476d43
Successfully tagged deislabs/helloworld-cnab:87d786be507769a4913c90d85134c85727c85f41
Successfully tagged cnab/helloworld-cnab:87d786be507769a4913c90d85134c85727c85f41
==> Successfully built bundle helloworld:0.1.1
```

Expand Down Expand Up @@ -105,8 +102,8 @@ Learn more about about CNAB and Duffle, check out our [docs](docs/README.md).
*Notes:*
* To build and install bundles, you need access to a Docker engine - it can be Docker for Mac, Docker for Windows, Docker on Linux, or a remote Docker engine. Duffle uses the Docker engine to build the invocation images, as well as for running actions inside invocation images.
* Duffle has a driver architecture for different ways of executing actions inside invocation images, and more drivers will be available in the future.
* Learn more about what a bundle is and its components [here](https://github.com/deislabs/cnab-spec/blob/master/100-CNAB.md).
* Get a feel for what CNAB bundles look like by referencing the [bundles repo](https://github.com/deislabs/bundles) on github.
* Learn more about what a bundle is and its components [here](https://github.com/cnabio/cnab-spec/blob/master/100-CNAB.md).
* Get a feel for what CNAB bundles written for duffle look like by referencing the [examples directory](./examples).

## Developing Duffle

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/bundle-guide.md
Expand Up @@ -124,5 +124,5 @@ The output of `duffle install` comes from the run script. `hello world` is print

## Notes and Next steps

- There are alternatives to defining a custom `run` tool. See examples of more complex and different bundles [here](https://github.com/deislabs/bundles).
- Read more about the CNAB spec in the [docs](https://github.com/deislabs/cnab-spec/blob/master/100-CNAB.md)
- There are alternatives to defining a custom `run` tool. See examples of more complex and different bundles [here](../../examples).
- Read more about the CNAB spec in the [docs](https://github.com/cnabio/cnab-spec/blob/master/100-CNAB.md)
File renamed without changes.
8 changes: 0 additions & 8 deletions examples/helloazure/README.md

This file was deleted.

12 changes: 0 additions & 12 deletions examples/helloazure/bundle.json

This file was deleted.

28 changes: 0 additions & 28 deletions examples/helloazure/cnab/app/run

This file was deleted.

2 changes: 0 additions & 2 deletions examples/values.toml

This file was deleted.

2 changes: 1 addition & 1 deletion governance.md
@@ -1,7 +1,7 @@
# Governance

## Project Maintainers
[Project maintainers](CODEOWNERS) are responsible for activities around maintaining and updating Duffle, the reference implementation for the [CNAB spec](https://github.com/deislabs/cnab-spec). Final decisions on the project reside with the project maintainers.
[Project maintainers](CODEOWNERS) are responsible for activities around maintaining and updating Duffle, the reference implementation for the [CNAB spec](https://github.com/cnabio/cnab-spec). Final decisions on the project reside with the project maintainers.

Maintainers MUST remain active. If they are unresponsive for >3 months, they will be automatically removed unless a [super-majority](https://en.wikipedia.org/wiki/Supermajority#Two-thirds_vote) of the other project maintainers agrees to extend the period to be greater than 3 months.

Expand Down

0 comments on commit 270e3ba

Please sign in to comment.