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

Commit

Permalink
Improve duffle.json docs (#801)
Browse files Browse the repository at this point in the history
Fixes #751
  • Loading branch information
benpatt authored and jeremyrickard committed Jul 24, 2019
1 parent 2120871 commit 53d3002
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions cmd/duffle/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ import (
)

const buildDesc = `
Builds a Cloud Native Application Bundle (CNAB) given a path to a directory that has a duffle build file (duffle.json).
Builds a Cloud Native Application Bundle (CNAB) given a path to a directory that has a duffle configuration file (duffle.json).
It builds the invocation images specified in the duffle build file and then creates or updates the bundle in local storage with the latest invocation images.
It builds the invocation images specified in the duffle configuration file and then creates or updates the bundle in local storage with the latest invocation images.
`

const (
Expand Down
2 changes: 1 addition & 1 deletion cmd/duffle/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For example, 'duffle create foo' will create a directory structure that looks l
foo/
|
|- duffle.json # The build definition file
|- duffle.json # The build configuration file
|
|- cnab/ # Contains invocation image
|
Expand Down
4 changes: 2 additions & 2 deletions docs/proposal/203-duffle-build.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Duffle Build

This document describes how `duffle build` works, and how it uses the duffle build file: `duffle.json`.
This document describes how `duffle build` works, and how it uses the duffle build configuration file: `duffle.json`.

`duffle build` take a path to a directory that contains a duffle build file (`duffle.json`) to build a Cloud Native Application Bundle (CNAB). In the process, it also builds all of the invocation images specified in the duffle build file.
`duffle build` take a path to a directory that contains a duffle build configuration file (`duffle.json`) to build a Cloud Native Application Bundle (CNAB). In the process, it also builds all of the invocation images specified in the duffle build configuration file.
2 changes: 1 addition & 1 deletion pkg/duffle/manifest/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ CMD ["/cnab/app/run"]

const schemaVersion = "v1.0.0-WD"

// Scaffold takes a path and creates a minimal duffle manifest (duffle.json)
// Scaffold takes a path and creates a minimal duffle configuration file (duffle.json)
// and scaffolds the components in that manifest
func Scaffold(path string) error {
name := filepath.Base(path)
Expand Down

0 comments on commit 53d3002

Please sign in to comment.