update documentation

Itai Gendler · Itai Gendler · commit 5c788205d64e · 2018-01-16T01:23:54.000+02:00
diff --git a/auto-docs/index.js b/auto-docs/index.js
@@ -22,7 +22,7 @@ recursive(path.resolve(__dirname, '../lib/interface/cli/commands'), (err, files)
         }
 
         const docs = command.prepareDocs();
-        if (!docs) {
+        if (!docs.category) {
             return;
         }
 
diff --git a/docs-template/content/authentication/Create authentication context.md b/docs-template/content/authentication/Create authentication context.md
@@ -3,7 +3,7 @@ title = "Create authentication context"
 +++
 
 ### Command
-`codefresh create-context [name]`
+`codefresh auth create-context [name]`
 
 Create or update an authentication context
 ### Positionals
diff --git a/docs-template/content/authentication/Get activated context.md b/docs-template/content/authentication/Get activated context.md
@@ -3,6 +3,6 @@ title = "Get activated context"
 +++
 
 ### Command
-`codefresh current-context`
+`codefresh auth current-context`
 
 Get the current activated authentication context
diff --git a/docs-template/content/authentication/Get all contexts.md b/docs-template/content/authentication/Get all contexts.md
@@ -3,6 +3,6 @@ title = "Get all contexts"
 +++
 
 ### Command
-`codefresh get-contexts`
+`codefresh auth get-contexts`
 
 Get all possible authentication contexts
diff --git a/docs-template/content/authentication/Set active context.md b/docs-template/content/authentication/Set active context.md
@@ -3,7 +3,7 @@ title = "Set active context"
 +++
 
 ### Command
-`codefresh use-context <name>`
+`codefresh auth use-context <name>`
 
 Set the current active authentication context
 ### Positionals
diff --git a/docs-template/content/authentication/_index.md b/docs-template/content/authentication/_index.md
@@ -3,22 +3,22 @@ title = "Authentication"
 +++
 
 ### [Create authentication context](create-authentication-context)
-`codefresh create-context [name]`
+`codefresh auth create-context [name]`
 
 Create or update an authentication context
 
 ### [Get activated context](get-activated-context)
-`codefresh current-context`
+`codefresh auth current-context`
 
 Get the current activated authentication context
 
 ### [Get all contexts](get-all-contexts)
-`codefresh get-contexts`
+`codefresh auth get-contexts`
 
 Get all possible authentication contexts
 
 ### [Set active context](set-active-context)
-`codefresh use-context <name>`
+`codefresh auth use-context <name>`
 
 Set the current active authentication context
 
diff --git a/docs-template/content/builds/Get a single build.md b/docs-template/content/builds/Get a single build.md
@@ -3,9 +3,9 @@ title = "Get a single build"
 +++
 
 ### Command
-`codefresh builds [id]`
+`codefresh get builds [id]`
 
-Get a specific builds or an array of builds
+Get a specific build or an array of builds
 ### Positionals
 
 Option | Default | Description
diff --git a/docs-template/content/builds/_index.md b/docs-template/content/builds/_index.md
@@ -3,9 +3,9 @@ title = "Builds"
 +++
 
 ### [Get a single build](get-a-single-build)
-`codefresh builds [id]`
+`codefresh get builds [id]`
 
-Get a specific builds or an array of builds
+Get a specific build or an array of builds
 
 ### [Show logs](show-logs)
 `codefresh logs <id>`
diff --git a/docs-template/content/compositions/Create a composition.md b/docs-template/content/compositions/Create a composition.md
@@ -3,7 +3,7 @@ title = "Create a composition"
 +++
 
 ### Command
-`codefresh composition [name]`
+`codefresh create composition [name]`
 
 Create a composition
 ### Positionals
diff --git a/docs-template/content/compositions/Delete a composition.md b/docs-template/content/compositions/Delete a composition.md
@@ -3,7 +3,7 @@ title = "Delete a composition"
 +++
 
 ### Command
-`codefresh composition [name]`
+`codefresh delete composition [name]`
 
 Delete a composition
 ### Positionals
diff --git a/docs-template/content/compositions/Get a single composition.md b/docs-template/content/compositions/Get a single composition.md
@@ -3,7 +3,7 @@ title = "Get a single composition"
 +++
 
 ### Command
-`codefresh compositions [id|name]`
+`codefresh get compositions [id|name]`
 
 Get a specific composition or an array of compositions
 ### Positionals
diff --git a/docs-template/content/compositions/Replace a composition.md b/docs-template/content/compositions/Replace a composition.md
@@ -3,6 +3,6 @@ title = "Replace a composition"
 +++
 
 ### Command
-`codefresh composition`
+`codefresh replace composition`
 
 Replace a composition resource
diff --git a/docs-template/content/compositions/_index.md b/docs-template/content/compositions/_index.md
@@ -3,22 +3,22 @@ title = "Compositions"
 +++
 
 ### [Create a composition](create-a-composition)
-`codefresh composition [name]`
+`codefresh create composition [name]`
 
 Create a composition
 
 ### [Delete a composition](delete-a-composition)
-`codefresh composition [name]`
+`codefresh delete composition [name]`
 
 Delete a composition
 
 ### [Get a single composition](get-a-single-composition)
-`codefresh compositions [id|name]`
+`codefresh get compositions [id|name]`
 
 Get a specific composition or an array of compositions
 
 ### [Replace a composition](replace-a-composition)
-`codefresh composition`
+`codefresh replace composition`
 
 Replace a composition resource
 
diff --git a/docs-template/content/contexts/Create a context.md b/docs-template/content/contexts/Create a context.md
@@ -3,7 +3,7 @@ title = "Create a context"
 +++
 
 ### Command
-`codefresh context [type] [name]`
+`codefresh create context [type] [name]`
 
 Create a context
 ### Positionals
diff --git a/docs-template/content/contexts/Delete a context.md b/docs-template/content/contexts/Delete a context.md
@@ -3,7 +3,7 @@ title = "Delete a context"
 +++
 
 ### Command
-`codefresh context [name]`
+`codefresh delete context [name]`
 
 Delete a context
 ### Positionals
diff --git a/docs-template/content/contexts/Get a single context.md b/docs-template/content/contexts/Get a single context.md
@@ -3,7 +3,7 @@ title = "Get a single context"
 +++
 
 ### Command
-`codefresh contexts [name]`
+`codefresh get contexts [name]`
 
 Get a specific or an array of contexts
 ### Positionals
diff --git a/docs-template/content/contexts/Replace a context.md b/docs-template/content/contexts/Replace a context.md
@@ -3,6 +3,6 @@ title = "Replace a context"
 +++
 
 ### Command
-`codefresh context`
+`codefresh replace context`
 
 Replace a context
diff --git a/docs-template/content/contexts/Update a context.md b/docs-template/content/contexts/Update a context.md
@@ -0,0 +1,8 @@
++++
+title = "Update a context"
++++
+
+### Command
+`codefresh patch context`
+
+Apply changes to a context
diff --git a/docs-template/content/contexts/Updated a context.md b/docs-template/content/contexts/Updated a context.md
diff --git a/docs-template/content/contexts/_index.md b/docs-template/content/contexts/_index.md
@@ -2,28 +2,28 @@
 title = "Contexts"
 +++
 
-### [Updated a context](updated-a-context)
-`codefresh context`
+### [Update a context](update-a-context)
+`codefresh patch context`
 
 Apply changes to a context
 
 ### [Create a context](create-a-context)
-`codefresh context [type] [name]`
+`codefresh create context [type] [name]`
 
 Create a context
 
 ### [Delete a context](delete-a-context)
-`codefresh context [name]`
+`codefresh delete context [name]`
 
 Delete a context
 
 ### [Get a single context](get-a-single-context)
-`codefresh contexts [name]`
+`codefresh get contexts [name]`
 
 Get a specific or an array of contexts
 
 ### [Replace a context](replace-a-context)
-`codefresh context`
+`codefresh replace context`
 
 Replace a context
 
diff --git a/docs-template/content/environments/Delete an environment.md b/docs-template/content/environments/Delete an environment.md
@@ -3,7 +3,7 @@ title = "Delete an environment"
 +++
 
 ### Command
-`codefresh environment <id>`
+`codefresh delete environment <id>`
 
 Delete an environment
 ### Positionals
diff --git a/docs-template/content/environments/Get a single composition.md b/docs-template/content/environments/Get a single composition.md
@@ -3,7 +3,7 @@ title = "Get a single composition"
 +++
 
 ### Command
-`codefresh environments [id]`
+`codefresh get environments [id]`
 
 Get a specific or an array of environments
 ### Positionals
diff --git a/docs-template/content/environments/_index.md b/docs-template/content/environments/_index.md
@@ -2,13 +2,13 @@
 title = "Environments"
 +++
 
-### [Delete an environment](delete-an-environment)
-`codefresh environment <id>`
-
-Delete an environment
-
 ### [Get a single composition](get-a-single-composition)
-`codefresh environments [id]`
+`codefresh get environments [id]`
 
 Get a specific or an array of environments
 
+### [Delete an environment](delete-an-environment)
+`codefresh delete environment <id>`
+
+Delete an environment
+
diff --git a/docs-template/content/images/Annotate an image.md b/docs-template/content/images/Annotate an image.md
@@ -3,7 +3,7 @@ title = "Annotate an image"
 +++
 
 ### Command
-`codefresh image <id>`
+`codefresh annotate image <id>`
 
 Annotate an image
 ### Positionals
diff --git a/docs-template/content/images/Get a single image.md b/docs-template/content/images/Get a single image.md
@@ -3,7 +3,7 @@ title = "Get a single image"
 +++
 
 ### Command
-`codefresh images [id]`
+`codefresh get images [id]`
 
 Get a specific or an array of images
 ### Positionals
diff --git a/docs-template/content/images/_index.md b/docs-template/content/images/_index.md
@@ -3,12 +3,12 @@ title = "Images"
 +++
 
 ### [Annotate an image](annotate-an-image)
-`codefresh image <id>`
+`codefresh annotate image <id>`
 
 Annotate an image
 
 ### [Get a single image](get-a-single-image)
-`codefresh images [id]`
+`codefresh get images [id]`
 
 Get a specific or an array of images
 
diff --git a/docs-template/content/pipelines/Get a single pipeline.md b/docs-template/content/pipelines/Get a single pipeline.md
@@ -3,7 +3,7 @@ title = "Get a single pipeline"
 +++
 
 ### Command
-`codefresh pipelines [id]`
+`codefresh get pipelines [id]`
 
 Get a specific or an array of pipelines
 ### Positionals
diff --git a/docs-template/content/pipelines/Update a single pipeline.md b/docs-template/content/pipelines/Update a single pipeline.md
@@ -3,7 +3,7 @@ title = "Update a single pipeline"
 +++
 
 ### Command
-`codefresh pipeline <id>`
+`codefresh patch pipeline <id>`
 
 Apply changes to a pipeline
 ### Positionals
diff --git a/docs-template/content/pipelines/_index.md b/docs-template/content/pipelines/_index.md
@@ -3,12 +3,12 @@ title = "Pipelines"
 +++
 
 ### [Update a single pipeline](update-a-single-pipeline)
-`codefresh pipeline <id>`
+`codefresh patch pipeline <id>`
 
 Apply changes to a pipeline
 
 ### [Get a single pipeline](get-a-single-pipeline)
-`codefresh pipelines [id]`
+`codefresh get pipelines [id]`
 
 Get a specific or an array of pipelines
 
diff --git a/docs-template/content/predefined pipelines/Delete a helm release.md b/docs-template/content/predefined pipelines/Delete a helm release.md
@@ -0,0 +1,17 @@
++++
+title = "Delete a helm release"
++++
+
+### Command
+`codefresh delete-release [name]`
+
+Delete a helm release
+### Options
+
+Option | Default | Description
+--------- | ----------- | -----------
+--cluster |  | Run on cluster
+--timeout | 300 | time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
+--purge |  | remove the release from the store and make its name free for later use (default true)
+--detach |  | Run pipeline and print build ID
+--no-hooks |  | prevent hooks from running during deletion
diff --git a/docs-template/content/predefined pipelines/Install or upgrade a Helm chart.md b/docs-template/content/predefined pipelines/Install or upgrade a Helm chart.md
@@ -1,20 +1,22 @@
 +++
-title = "Install or upgrade Helm chart"
+title = "Install or upgrade a Helm chart"
 +++
 
 ### Command
 `codefresh install-chart`
 
-Install or upgrade Helm chart
+Install or upgrade a Helm chart
+            Repository flag can be either absolute url or saved repository in Codefresh
 ### Options
 
 Option | Default | Description
 --------- | ----------- | -----------
 --cluster |  | Install on cluster
 --namespace | default | Install on namespace
 --tiller-namespace | kube-system | Where tiller has been installed
---repository |  | Helm repository
+--repository |  | Helm repository (absolute url or name of context with type help-repository)
 --name |  | Name of the chart in the repository
 --version |  | Version of the chart in the repository
 --context |  | Contexts (yaml || secret-yaml) to be passed to the install
+--detach |  | Run pipeline and print build ID
 --release-name |  | The name to set to the release
diff --git a/docs-template/content/predefined pipelines/Test a helm release.md b/docs-template/content/predefined pipelines/Test a helm release.md
diff --git a/docs-template/content/predefined pipelines/_index.md b/docs-template/content/predefined pipelines/_index.md
diff --git a/lib/interface/cli/Command.js b/lib/interface/cli/Command.js
diff --git a/lib/interface/cli/commands/pipeline/dynamic/delete-release.cmd.js b/lib/interface/cli/commands/pipeline/dynamic/delete-release.cmd.js
diff --git a/lib/interface/cli/commands/pipeline/dynamic/install-chart.cmd.js b/lib/interface/cli/commands/pipeline/dynamic/install-chart.cmd.js

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ recursive(path.resolve(__dirname, '../lib/interface/cli/commands'), (err, files)`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`const docs = command.prepareDocs();`
`25`		`- if (!docs) {`
	`25`	`+ if (!docs.category) {`
`26`	`26`	`return;`
`27`	`27`	`}`
`28`	`28`