Skip to content

Commit 5c78820

Browse files
Itai GendlerItai Gendler
authored andcommitted
update documentation
1 parent 59ca43e commit 5c78820

36 files changed

+97
-64
lines changed

auto-docs/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ recursive(path.resolve(__dirname, '../lib/interface/cli/commands'), (err, files)
2222
}
2323

2424
const docs = command.prepareDocs();
25-
if (!docs) {
25+
if (!docs.category) {
2626
return;
2727
}
2828

docs-template/content/authentication/Create authentication context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Create authentication context"
33
+++
44

55
### Command
6-
`codefresh create-context [name]`
6+
`codefresh auth create-context [name]`
77

88
Create or update an authentication context
99
### Positionals

docs-template/content/authentication/Get activated context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ title = "Get activated context"
33
+++
44

55
### Command
6-
`codefresh current-context`
6+
`codefresh auth current-context`
77

88
Get the current activated authentication context

docs-template/content/authentication/Get all contexts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ title = "Get all contexts"
33
+++
44

55
### Command
6-
`codefresh get-contexts`
6+
`codefresh auth get-contexts`
77

88
Get all possible authentication contexts

docs-template/content/authentication/Set active context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Set active context"
33
+++
44

55
### Command
6-
`codefresh use-context <name>`
6+
`codefresh auth use-context <name>`
77

88
Set the current active authentication context
99
### Positionals

docs-template/content/authentication/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@ title = "Authentication"
33
+++
44

55
### [Create authentication context](create-authentication-context)
6-
`codefresh create-context [name]`
6+
`codefresh auth create-context [name]`
77

88
Create or update an authentication context
99

1010
### [Get activated context](get-activated-context)
11-
`codefresh current-context`
11+
`codefresh auth current-context`
1212

1313
Get the current activated authentication context
1414

1515
### [Get all contexts](get-all-contexts)
16-
`codefresh get-contexts`
16+
`codefresh auth get-contexts`
1717

1818
Get all possible authentication contexts
1919

2020
### [Set active context](set-active-context)
21-
`codefresh use-context <name>`
21+
`codefresh auth use-context <name>`
2222

2323
Set the current active authentication context
2424

docs-template/content/builds/Get a single build.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title = "Get a single build"
33
+++
44

55
### Command
6-
`codefresh builds [id]`
6+
`codefresh get builds [id]`
77

8-
Get a specific builds or an array of builds
8+
Get a specific build or an array of builds
99
### Positionals
1010

1111
Option | Default | Description

docs-template/content/builds/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title = "Builds"
33
+++
44

55
### [Get a single build](get-a-single-build)
6-
`codefresh builds [id]`
6+
`codefresh get builds [id]`
77

8-
Get a specific builds or an array of builds
8+
Get a specific build or an array of builds
99

1010
### [Show logs](show-logs)
1111
`codefresh logs <id>`

docs-template/content/compositions/Create a composition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Create a composition"
33
+++
44

55
### Command
6-
`codefresh composition [name]`
6+
`codefresh create composition [name]`
77

88
Create a composition
99
### Positionals

docs-template/content/compositions/Delete a composition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Delete a composition"
33
+++
44

55
### Command
6-
`codefresh composition [name]`
6+
`codefresh delete composition [name]`
77

88
Delete a composition
99
### Positionals

docs-template/content/compositions/Get a single composition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Get a single composition"
33
+++
44

55
### Command
6-
`codefresh compositions [id|name]`
6+
`codefresh get compositions [id|name]`
77

88
Get a specific composition or an array of compositions
99
### Positionals

docs-template/content/compositions/Replace a composition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ title = "Replace a composition"
33
+++
44

55
### Command
6-
`codefresh composition`
6+
`codefresh replace composition`
77

88
Replace a composition resource

docs-template/content/compositions/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@ title = "Compositions"
33
+++
44

55
### [Create a composition](create-a-composition)
6-
`codefresh composition [name]`
6+
`codefresh create composition [name]`
77

88
Create a composition
99

1010
### [Delete a composition](delete-a-composition)
11-
`codefresh composition [name]`
11+
`codefresh delete composition [name]`
1212

1313
Delete a composition
1414

1515
### [Get a single composition](get-a-single-composition)
16-
`codefresh compositions [id|name]`
16+
`codefresh get compositions [id|name]`
1717

1818
Get a specific composition or an array of compositions
1919

2020
### [Replace a composition](replace-a-composition)
21-
`codefresh composition`
21+
`codefresh replace composition`
2222

2323
Replace a composition resource
2424

docs-template/content/contexts/Create a context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Create a context"
33
+++
44

55
### Command
6-
`codefresh context [type] [name]`
6+
`codefresh create context [type] [name]`
77

88
Create a context
99
### Positionals

docs-template/content/contexts/Delete a context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Delete a context"
33
+++
44

55
### Command
6-
`codefresh context [name]`
6+
`codefresh delete context [name]`
77

88
Delete a context
99
### Positionals

docs-template/content/contexts/Get a single context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Get a single context"
33
+++
44

55
### Command
6-
`codefresh contexts [name]`
6+
`codefresh get contexts [name]`
77

88
Get a specific or an array of contexts
99
### Positionals

docs-template/content/contexts/Replace a context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ title = "Replace a context"
33
+++
44

55
### Command
6-
`codefresh context`
6+
`codefresh replace context`
77

88
Replace a context
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
+++
2+
title = "Update a context"
3+
+++
4+
5+
### Command
6+
`codefresh patch context`
7+
8+
Apply changes to a context

docs-template/content/contexts/Updated a context.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs-template/content/contexts/_index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,28 @@
22
title = "Contexts"
33
+++
44

5-
### [Updated a context](updated-a-context)
6-
`codefresh context`
5+
### [Update a context](update-a-context)
6+
`codefresh patch context`
77

88
Apply changes to a context
99

1010
### [Create a context](create-a-context)
11-
`codefresh context [type] [name]`
11+
`codefresh create context [type] [name]`
1212

1313
Create a context
1414

1515
### [Delete a context](delete-a-context)
16-
`codefresh context [name]`
16+
`codefresh delete context [name]`
1717

1818
Delete a context
1919

2020
### [Get a single context](get-a-single-context)
21-
`codefresh contexts [name]`
21+
`codefresh get contexts [name]`
2222

2323
Get a specific or an array of contexts
2424

2525
### [Replace a context](replace-a-context)
26-
`codefresh context`
26+
`codefresh replace context`
2727

2828
Replace a context
2929

docs-template/content/environments/Delete an environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Delete an environment"
33
+++
44

55
### Command
6-
`codefresh environment <id>`
6+
`codefresh delete environment <id>`
77

88
Delete an environment
99
### Positionals

docs-template/content/environments/Get a single composition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Get a single composition"
33
+++
44

55
### Command
6-
`codefresh environments [id]`
6+
`codefresh get environments [id]`
77

88
Get a specific or an array of environments
99
### Positionals

docs-template/content/environments/_index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
title = "Environments"
33
+++
44

5-
### [Delete an environment](delete-an-environment)
6-
`codefresh environment <id>`
7-
8-
Delete an environment
9-
105
### [Get a single composition](get-a-single-composition)
11-
`codefresh environments [id]`
6+
`codefresh get environments [id]`
127

138
Get a specific or an array of environments
149

10+
### [Delete an environment](delete-an-environment)
11+
`codefresh delete environment <id>`
12+
13+
Delete an environment
14+

docs-template/content/images/Annotate an image.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Annotate an image"
33
+++
44

55
### Command
6-
`codefresh image <id>`
6+
`codefresh annotate image <id>`
77

88
Annotate an image
99
### Positionals

docs-template/content/images/Get a single image.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Get a single image"
33
+++
44

55
### Command
6-
`codefresh images [id]`
6+
`codefresh get images [id]`
77

88
Get a specific or an array of images
99
### Positionals

docs-template/content/images/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ title = "Images"
33
+++
44

55
### [Annotate an image](annotate-an-image)
6-
`codefresh image <id>`
6+
`codefresh annotate image <id>`
77

88
Annotate an image
99

1010
### [Get a single image](get-a-single-image)
11-
`codefresh images [id]`
11+
`codefresh get images [id]`
1212

1313
Get a specific or an array of images
1414

docs-template/content/pipelines/Get a single pipeline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Get a single pipeline"
33
+++
44

55
### Command
6-
`codefresh pipelines [id]`
6+
`codefresh get pipelines [id]`
77

88
Get a specific or an array of pipelines
99
### Positionals

docs-template/content/pipelines/Update a single pipeline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Update a single pipeline"
33
+++
44

55
### Command
6-
`codefresh pipeline <id>`
6+
`codefresh patch pipeline <id>`
77

88
Apply changes to a pipeline
99
### Positionals

docs-template/content/pipelines/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ title = "Pipelines"
33
+++
44

55
### [Update a single pipeline](update-a-single-pipeline)
6-
`codefresh pipeline <id>`
6+
`codefresh patch pipeline <id>`
77

88
Apply changes to a pipeline
99

1010
### [Get a single pipeline](get-a-single-pipeline)
11-
`codefresh pipelines [id]`
11+
`codefresh get pipelines [id]`
1212

1313
Get a specific or an array of pipelines
1414

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
+++
2+
title = "Delete a helm release"
3+
+++
4+
5+
### Command
6+
`codefresh delete-release [name]`
7+
8+
Delete a helm release
9+
### Options
10+
11+
Option | Default | Description
12+
--------- | ----------- | -----------
13+
--cluster | | Run on cluster
14+
--timeout | 300 | time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
15+
--purge | | remove the release from the store and make its name free for later use (default true)
16+
--detach | | Run pipeline and print build ID
17+
--no-hooks | | prevent hooks from running during deletion
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
+++
2-
title = "Install or upgrade Helm chart"
2+
title = "Install or upgrade a Helm chart"
33
+++
44

55
### Command
66
`codefresh install-chart`
77

8-
Install or upgrade Helm chart
8+
Install or upgrade a Helm chart
9+
Repository flag can be either absolute url or saved repository in Codefresh
910
### Options
1011

1112
Option | Default | Description
1213
--------- | ----------- | -----------
1314
--cluster | | Install on cluster
1415
--namespace | default | Install on namespace
1516
--tiller-namespace | kube-system | Where tiller has been installed
16-
--repository | | Helm repository
17+
--repository | | Helm repository (absolute url or name of context with type help-repository)
1718
--name | | Name of the chart in the repository
1819
--version | | Version of the chart in the repository
1920
--context | | Contexts (yaml || secret-yaml) to be passed to the install
21+
--detach | | Run pipeline and print build ID
2022
--release-name | | The name to set to the release

0 commit comments

Comments
 (0)