From 53d30025c7f2a167ff4d2a8ec230692566a63828 Mon Sep 17 00:00:00 2001 From: Ben Patterson Date: Wed, 24 Jul 2019 16:37:17 +0100 Subject: [PATCH] Improve duffle.json docs (#801) Fixes https://github.com/deislabs/duffle/issues/751 --- cmd/duffle/build.go | 4 ++-- cmd/duffle/create.go | 2 +- docs/proposal/203-duffle-build.md | 4 ++-- pkg/duffle/manifest/create.go | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/cmd/duffle/build.go b/cmd/duffle/build.go index 79074c9d..dbc34f4f 100644 --- a/cmd/duffle/build.go +++ b/cmd/duffle/build.go @@ -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 ( diff --git a/cmd/duffle/create.go b/cmd/duffle/create.go index eae2ea53..1de65f34 100644 --- a/cmd/duffle/create.go +++ b/cmd/duffle/create.go @@ -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 | diff --git a/docs/proposal/203-duffle-build.md b/docs/proposal/203-duffle-build.md index 780aab91..6518812e 100644 --- a/docs/proposal/203-duffle-build.md +++ b/docs/proposal/203-duffle-build.md @@ -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. diff --git a/pkg/duffle/manifest/create.go b/pkg/duffle/manifest/create.go index f0f091c1..ce9d86c3 100644 --- a/pkg/duffle/manifest/create.go +++ b/pkg/duffle/manifest/create.go @@ -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)