Skip to content

Commit b89e3e2

Browse files
Itai GendlerItai Gendler
Itai Gendler
authored and
Itai Gendler
committed
update documentation
1 parent 5c78820 commit b89e3e2

File tree

51 files changed

+2034
-437
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+2034
-437
lines changed

‎docs-template/content/environments/_index.md

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

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

138
Delete an environment
149

10+
### [Get a single composition](get-a-single-composition)
11+
`codefresh get environments [id]`
12+
13+
Get a specific or an array of environments
14+

‎docs/404.html

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -192,9 +192,9 @@
192192
<span>Replace a context</span>
193193
</a>
194194
</li>
195-
<li data-nav-id="/contexts/updated-a-context/" class="dd-item">
196-
<a href="/contexts/updated-a-context/">
197-
<span>Updated a context</span>
195+
<li data-nav-id="/contexts/update-a-context/" class="dd-item">
196+
<a href="/contexts/update-a-context/">
197+
<span>Update a context</span>
198198
</a>
199199
</li>
200200
</ul>
@@ -265,9 +265,14 @@
265265
<span>Predefined Pipelines</span><i class="fa fa-angle-right fa-lg category-icon"></i>
266266
</a>
267267
<ul>
268-
<li data-nav-id="/predefined-pipelines/install-or-upgrade-helm-chart/" class="dd-item">
269-
<a href="/predefined-pipelines/install-or-upgrade-helm-chart/">
270-
<span>Install or upgrade Helm chart</span>
268+
<li data-nav-id="/predefined-pipelines/delete-a-helm-release/" class="dd-item">
269+
<a href="/predefined-pipelines/delete-a-helm-release/">
270+
<span>Delete a helm release</span>
271+
</a>
272+
</li>
273+
<li data-nav-id="/predefined-pipelines/install-or-upgrade-a-helm-chart/" class="dd-item">
274+
<a href="/predefined-pipelines/install-or-upgrade-a-helm-chart/">
275+
<span>Install or upgrade a Helm chart</span>
271276
</a>
272277
</li>
273278
<li data-nav-id="/predefined-pipelines/test-a-helm-release/" class="dd-item">

‎docs/_header/index.html

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -192,9 +192,9 @@
192192
<span>Replace a context</span>
193193
</a>
194194
</li>
195-
<li data-nav-id="/contexts/updated-a-context/" class="dd-item">
196-
<a href="/contexts/updated-a-context/">
197-
<span>Updated a context</span>
195+
<li data-nav-id="/contexts/update-a-context/" class="dd-item">
196+
<a href="/contexts/update-a-context/">
197+
<span>Update a context</span>
198198
</a>
199199
</li>
200200
</ul>
@@ -265,9 +265,14 @@
265265
<span>Predefined Pipelines</span><i class="fa fa-angle-right fa-lg category-icon"></i>
266266
</a>
267267
<ul>
268-
<li data-nav-id="/predefined-pipelines/install-or-upgrade-helm-chart/" class="dd-item">
269-
<a href="/predefined-pipelines/install-or-upgrade-helm-chart/">
270-
<span>Install or upgrade Helm chart</span>
268+
<li data-nav-id="/predefined-pipelines/delete-a-helm-release/" class="dd-item">
269+
<a href="/predefined-pipelines/delete-a-helm-release/">
270+
<span>Delete a helm release</span>
271+
</a>
272+
</li>
273+
<li data-nav-id="/predefined-pipelines/install-or-upgrade-a-helm-chart/" class="dd-item">
274+
<a href="/predefined-pipelines/install-or-upgrade-a-helm-chart/">
275+
<span>Install or upgrade a Helm chart</span>
271276
</a>
272277
</li>
273278
<li data-nav-id="/predefined-pipelines/test-a-helm-release/" class="dd-item">

‎docs/authentication/create-authentication-context/index.html

Lines changed: 9 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -173,31 +173,6 @@
173173
<span>Contexts</span><i class="fa fa-angle-right fa-lg category-icon"></i>
174174
</a>
175175
<ul>
176-
<li data-nav-id="/contexts/create-a-context/" class="dd-item">
177-
<a href="/contexts/create-a-context/">
178-
<span>Create a context</span>
179-
</a>
180-
</li>
181-
<li data-nav-id="/contexts/delete-a-context/" class="dd-item">
182-
<a href="/contexts/delete-a-context/">
183-
<span>Delete a context</span>
184-
</a>
185-
</li>
186-
<li data-nav-id="/contexts/get-a-single-context/" class="dd-item">
187-
<a href="/contexts/get-a-single-context/">
188-
<span>Get a single context</span>
189-
</a>
190-
</li>
191-
<li data-nav-id="/contexts/replace-a-context/" class="dd-item">
192-
<a href="/contexts/replace-a-context/">
193-
<span>Replace a context</span>
194-
</a>
195-
</li>
196-
<li data-nav-id="/contexts/updated-a-context/" class="dd-item">
197-
<a href="/contexts/updated-a-context/">
198-
<span>Updated a context</span>
199-
</a>
200-
</li>
201176
</ul>
202177
</li>
203178
<li data-nav-id="/environments/" class="dd-item">
@@ -266,9 +241,14 @@
266241
<span>Predefined Pipelines</span><i class="fa fa-angle-right fa-lg category-icon"></i>
267242
</a>
268243
<ul>
269-
<li data-nav-id="/predefined-pipelines/install-or-upgrade-helm-chart/" class="dd-item">
270-
<a href="/predefined-pipelines/install-or-upgrade-helm-chart/">
271-
<span>Install or upgrade Helm chart</span>
244+
<li data-nav-id="/predefined-pipelines/delete-a-helm-release/" class="dd-item">
245+
<a href="/predefined-pipelines/delete-a-helm-release/">
246+
<span>Delete a helm release</span>
247+
</a>
248+
</li>
249+
<li data-nav-id="/predefined-pipelines/install-or-upgrade-a-helm-chart/" class="dd-item">
250+
<a href="/predefined-pipelines/install-or-upgrade-a-helm-chart/">
251+
<span>Install or upgrade a Helm chart</span>
272252
</a>
273253
</li>
274254
<li data-nav-id="/predefined-pipelines/test-a-helm-release/" class="dd-item">
@@ -380,7 +360,7 @@ <h1>Create authentication context</h1>
380360

381361
<h3 id="command">Command</h3>
382362

383-
<p><code>codefresh create-context [name]</code></p>
363+
<p><code>codefresh auth create-context [name]</code></p>
384364

385365
<p>Create or update an authentication context</p>
386366

‎docs/authentication/get-activated-context/index.html

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,9 @@
193193
<span>Replace a context</span>
194194
</a>
195195
</li>
196-
<li data-nav-id="/contexts/updated-a-context/" class="dd-item">
197-
<a href="/contexts/updated-a-context/">
198-
<span>Updated a context</span>
196+
<li data-nav-id="/contexts/update-a-context/" class="dd-item">
197+
<a href="/contexts/update-a-context/">
198+
<span>Update a context</span>
199199
</a>
200200
</li>
201201
</ul>
@@ -266,9 +266,14 @@
266266
<span>Predefined Pipelines</span><i class="fa fa-angle-right fa-lg category-icon"></i>
267267
</a>
268268
<ul>
269-
<li data-nav-id="/predefined-pipelines/install-or-upgrade-helm-chart/" class="dd-item">
270-
<a href="/predefined-pipelines/install-or-upgrade-helm-chart/">
271-
<span>Install or upgrade Helm chart</span>
269+
<li data-nav-id="/predefined-pipelines/delete-a-helm-release/" class="dd-item">
270+
<a href="/predefined-pipelines/delete-a-helm-release/">
271+
<span>Delete a helm release</span>
272+
</a>
273+
</li>
274+
<li data-nav-id="/predefined-pipelines/install-or-upgrade-a-helm-chart/" class="dd-item">
275+
<a href="/predefined-pipelines/install-or-upgrade-a-helm-chart/">
276+
<span>Install or upgrade a Helm chart</span>
272277
</a>
273278
</li>
274279
<li data-nav-id="/predefined-pipelines/test-a-helm-release/" class="dd-item">
@@ -378,7 +383,7 @@ <h1>Get activated context</h1>
378383

379384
<h3 id="command">Command</h3>
380385

381-
<p><code>codefresh current-context</code></p>
386+
<p><code>codefresh auth current-context</code></p>
382387

383388
<p>Get the current activated authentication context</p>
384389

‎docs/authentication/get-all-contexts/index.html

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,9 @@
193193
<span>Replace a context</span>
194194
</a>
195195
</li>
196-
<li data-nav-id="/contexts/updated-a-context/" class="dd-item">
197-
<a href="/contexts/updated-a-context/">
198-
<span>Updated a context</span>
196+
<li data-nav-id="/contexts/update-a-context/" class="dd-item">
197+
<a href="/contexts/update-a-context/">
198+
<span>Update a context</span>
199199
</a>
200200
</li>
201201
</ul>
@@ -266,9 +266,14 @@
266266
<span>Predefined Pipelines</span><i class="fa fa-angle-right fa-lg category-icon"></i>
267267
</a>
268268
<ul>
269-
<li data-nav-id="/predefined-pipelines/install-or-upgrade-helm-chart/" class="dd-item">
270-
<a href="/predefined-pipelines/install-or-upgrade-helm-chart/">
271-
<span>Install or upgrade Helm chart</span>
269+
<li data-nav-id="/predefined-pipelines/delete-a-helm-release/" class="dd-item">
270+
<a href="/predefined-pipelines/delete-a-helm-release/">
271+
<span>Delete a helm release</span>
272+
</a>
273+
</li>
274+
<li data-nav-id="/predefined-pipelines/install-or-upgrade-a-helm-chart/" class="dd-item">
275+
<a href="/predefined-pipelines/install-or-upgrade-a-helm-chart/">
276+
<span>Install or upgrade a Helm chart</span>
272277
</a>
273278
</li>
274279
<li data-nav-id="/predefined-pipelines/test-a-helm-release/" class="dd-item">
@@ -378,7 +383,7 @@ <h1>Get all contexts</h1>
378383

379384
<h3 id="command">Command</h3>
380385

381-
<p><code>codefresh get-contexts</code></p>
386+
<p><code>codefresh auth get-contexts</code></p>
382387

383388
<p>Get all possible authentication contexts</p>
384389

‎docs/authentication/index.html

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,9 @@
193193
<span>Replace a context</span>
194194
</a>
195195
</li>
196-
<li data-nav-id="/contexts/updated-a-context/" class="dd-item">
197-
<a href="/contexts/updated-a-context/">
198-
<span>Updated a context</span>
196+
<li data-nav-id="/contexts/update-a-context/" class="dd-item">
197+
<a href="/contexts/update-a-context/">
198+
<span>Update a context</span>
199199
</a>
200200
</li>
201201
</ul>
@@ -266,9 +266,14 @@
266266
<span>Predefined Pipelines</span><i class="fa fa-angle-right fa-lg category-icon"></i>
267267
</a>
268268
<ul>
269-
<li data-nav-id="/predefined-pipelines/install-or-upgrade-helm-chart/" class="dd-item">
270-
<a href="/predefined-pipelines/install-or-upgrade-helm-chart/">
271-
<span>Install or upgrade Helm chart</span>
269+
<li data-nav-id="/predefined-pipelines/delete-a-helm-release/" class="dd-item">
270+
<a href="/predefined-pipelines/delete-a-helm-release/">
271+
<span>Delete a helm release</span>
272+
</a>
273+
</li>
274+
<li data-nav-id="/predefined-pipelines/install-or-upgrade-a-helm-chart/" class="dd-item">
275+
<a href="/predefined-pipelines/install-or-upgrade-a-helm-chart/">
276+
<span>Install or upgrade a Helm chart</span>
272277
</a>
273278
</li>
274279
<li data-nav-id="/predefined-pipelines/test-a-helm-release/" class="dd-item">
@@ -377,25 +382,25 @@ <h1>Authentication</h1>
377382

378383
<h3 id="create-authentication-context-create-authentication-context"><a href="create-authentication-context">Create authentication context</a></h3>
379384

380-
<p><code>codefresh create-context [name]</code></p>
385+
<p><code>codefresh auth create-context [name]</code></p>
381386

382387
<p>Create or update an authentication context</p>
383388

384389
<h3 id="get-activated-context-get-activated-context"><a href="get-activated-context">Get activated context</a></h3>
385390

386-
<p><code>codefresh current-context</code></p>
391+
<p><code>codefresh auth current-context</code></p>
387392

388393
<p>Get the current activated authentication context</p>
389394

390395
<h3 id="get-all-contexts-get-all-contexts"><a href="get-all-contexts">Get all contexts</a></h3>
391396

392-
<p><code>codefresh get-contexts</code></p>
397+
<p><code>codefresh auth get-contexts</code></p>
393398

394399
<p>Get all possible authentication contexts</p>
395400

396401
<h3 id="set-active-context-set-active-context"><a href="set-active-context">Set active context</a></h3>
397402

398-
<p><code>codefresh use-context &lt;name&gt;</code></p>
403+
<p><code>codefresh auth use-context &lt;name&gt;</code></p>
399404

400405
<p>Set the current active authentication context</p>
401406

‎docs/authentication/set-active-context/index.html

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,9 @@
193193
<span>Replace a context</span>
194194
</a>
195195
</li>
196-
<li data-nav-id="/contexts/updated-a-context/" class="dd-item">
197-
<a href="/contexts/updated-a-context/">
198-
<span>Updated a context</span>
196+
<li data-nav-id="/contexts/update-a-context/" class="dd-item">
197+
<a href="/contexts/update-a-context/">
198+
<span>Update a context</span>
199199
</a>
200200
</li>
201201
</ul>
@@ -266,9 +266,14 @@
266266
<span>Predefined Pipelines</span><i class="fa fa-angle-right fa-lg category-icon"></i>
267267
</a>
268268
<ul>
269-
<li data-nav-id="/predefined-pipelines/install-or-upgrade-helm-chart/" class="dd-item">
270-
<a href="/predefined-pipelines/install-or-upgrade-helm-chart/">
271-
<span>Install or upgrade Helm chart</span>
269+
<li data-nav-id="/predefined-pipelines/delete-a-helm-release/" class="dd-item">
270+
<a href="/predefined-pipelines/delete-a-helm-release/">
271+
<span>Delete a helm release</span>
272+
</a>
273+
</li>
274+
<li data-nav-id="/predefined-pipelines/install-or-upgrade-a-helm-chart/" class="dd-item">
275+
<a href="/predefined-pipelines/install-or-upgrade-a-helm-chart/">
276+
<span>Install or upgrade a Helm chart</span>
272277
</a>
273278
</li>
274279
<li data-nav-id="/predefined-pipelines/test-a-helm-release/" class="dd-item">
@@ -379,7 +384,7 @@ <h1>Set active context</h1>
379384

380385
<h3 id="command">Command</h3>
381386

382-
<p><code>codefresh use-context &lt;name&gt;</code></p>
387+
<p><code>codefresh auth use-context &lt;name&gt;</code></p>
383388

384389
<p>Set the current active authentication context</p>
385390

‎docs/builds/get-a-single-build/index.html

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,9 @@
193193
<span>Replace a context</span>
194194
</a>
195195
</li>
196-
<li data-nav-id="/contexts/updated-a-context/" class="dd-item">
197-
<a href="/contexts/updated-a-context/">
198-
<span>Updated a context</span>
196+
<li data-nav-id="/contexts/update-a-context/" class="dd-item">
197+
<a href="/contexts/update-a-context/">
198+
<span>Update a context</span>
199199
</a>
200200
</li>
201201
</ul>
@@ -205,16 +205,6 @@
205205
<span>Environments</span><i class="fa fa-angle-right fa-lg category-icon"></i>
206206
</a>
207207
<ul>
208-
<li data-nav-id="/environments/delete-an-environment/" class="dd-item">
209-
<a href="/environments/delete-an-environment/">
210-
<span>Delete an environment</span>
211-
</a>
212-
</li>
213-
<li data-nav-id="/environments/get-a-single-composition/" class="dd-item">
214-
<a href="/environments/get-a-single-composition/">
215-
<span>Get a single composition</span>
216-
</a>
217-
</li>
218208
</ul>
219209
</li>
220210
<li data-nav-id="/images/" class="dd-item">
@@ -266,9 +256,14 @@
266256
<span>Predefined Pipelines</span><i class="fa fa-angle-right fa-lg category-icon"></i>
267257
</a>
268258
<ul>
269-
<li data-nav-id="/predefined-pipelines/install-or-upgrade-helm-chart/" class="dd-item">
270-
<a href="/predefined-pipelines/install-or-upgrade-helm-chart/">
271-
<span>Install or upgrade Helm chart</span>
259+
<li data-nav-id="/predefined-pipelines/delete-a-helm-release/" class="dd-item">
260+
<a href="/predefined-pipelines/delete-a-helm-release/">
261+
<span>Delete a helm release</span>
262+
</a>
263+
</li>
264+
<li data-nav-id="/predefined-pipelines/install-or-upgrade-a-helm-chart/" class="dd-item">
265+
<a href="/predefined-pipelines/install-or-upgrade-a-helm-chart/">
266+
<span>Install or upgrade a Helm chart</span>
272267
</a>
273268
</li>
274269
<li data-nav-id="/predefined-pipelines/test-a-helm-release/" class="dd-item">
@@ -380,9 +375,9 @@ <h1>Get a single build</h1>
380375

381376
<h3 id="command">Command</h3>
382377

383-
<p><code>codefresh builds [id]</code></p>
378+
<p><code>codefresh get builds [id]</code></p>
384379

385-
<p>Get a specific builds or an array of builds</p>
380+
<p>Get a specific build or an array of builds</p>
386381

387382
<h3 id="positionals">Positionals</h3>
388383

0 commit comments

Comments
 (0)