From 823df445010f12ef7497de1c7aeae2227f2649b8 Mon Sep 17 00:00:00 2001 From: Bryan Strassner Date: Thu, 12 Oct 2017 20:56:00 -0500 Subject: [PATCH] Update shipyard CLI documentation for shipyard create configdocs command. Change-Id: Iec215848c2a65d9d83d56a7aa293b24ea6a03d55 --- docs/CLI.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/CLI.md b/docs/CLI.md index cfd144de..ab9e44a4 100644 --- a/docs/CLI.md +++ b/docs/CLI.md @@ -156,18 +156,25 @@ Example: ## create configdocs -Load documents into the Shipyard Buffer. +Load documents into the Shipyard Buffer. The use of one or more filename or +a single directory option must be specified. + ``` shipyard create configdocs [--append | --replace] - [--filename= (repeatable) + --filename= (repeatable) | - --directory=] + --directory= Example: shipyard create configdocs design --append --filename=site_design.yaml ``` +Note: If neither append or replace are specified, the Shipyard API default +value of rejectoncontents will be used. + +Note: Either --filename or --directory must be specified, but both may not be +specified for the same invocation of shipyard.
<collection>
@@ -186,13 +193,15 @@ Example:
The file name to use as the contents of the collection. (repeatable) If any documents specified fail basic validation, all of the documents - will be rejected. + will be rejected. Use of filename parameters may not be used in + conjunction with the directory parameter.
--directory=<directory>
A directory containing documents that will be joined and loaded as a collection. Any documents that fail basic validation will reject the - whole set. + whole set. Use of the directory parameter may not be used with the filename + parameter.