Skip to content

Commit f10f3c8

Browse files
Itai GendlerItai Gendler
Itai Gendler
authored and
Itai Gendler
committed
Update documentation
1 parent 7ffffb6 commit f10f3c8

File tree

51 files changed

+44
-746
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

+44
-746
lines changed

‎docs-template/content/getting-started/_index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ date = "2017-04-24T18:36:24+02:00"
55
weight = 10
66
+++
77

8-
## install
8+
## Install
99
Install the CLI through one of the possible ways described in the [Installation](/installation) page
1010

11-
## authenticate
11+
## Authenticate
1212
In order to start working with the cli you will need to update the authentication configuration. <br />
1313
Updating the authentication configuration is done via an API-KEY you generate from Codefresh. <br />
1414

@@ -18,6 +18,12 @@ You can generate a new one from the <a href="https://g.codefresh.io/account/toke
1818

1919
Once you have an API key, create a new authentication context:<br> `codefresh auth create-context --api-key {API_KEY}`
2020

21+
## Getting Help
22+
To get help and usage instructions run `codefresh [COMMAND]--help`.<br />
23+
A help message will appear in the terminal.<br />
24+
25+
## Showing Current Version
26+
Run `codefresh version` to see the current CLI version.
2127

2228
<br />
2329
#### That's it, you are good to go!

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

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

‎docs-template/content/help/version.md

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

‎docs/404.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -277,18 +277,6 @@
277277
</li>
278278
</ul>
279279
</li>
280-
<li data-nav-id="/help/" class="dd-item">
281-
<a href="/help/">
282-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
283-
</a>
284-
<ul>
285-
<li data-nav-id="/help/version/" class="dd-item">
286-
<a href="/help/version/">
287-
<span>Version</span>
288-
</a>
289-
</li>
290-
</ul>
291-
</li>
292280

293281

294282

‎docs/_header/index.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -277,18 +277,6 @@
277277
</li>
278278
</ul>
279279
</li>
280-
<li data-nav-id="/help/" class="dd-item">
281-
<a href="/help/">
282-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
283-
</a>
284-
<ul>
285-
<li data-nav-id="/help/version/" class="dd-item">
286-
<a href="/help/version/">
287-
<span>Version</span>
288-
</a>
289-
</li>
290-
</ul>
291-
</li>
292280

293281

294282

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

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

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

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

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

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

‎docs/authentication/index.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

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

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

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

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

‎docs/builds/index.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

‎docs/builds/restart-a-build/index.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

‎docs/builds/show-logs/index.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

‎docs/builds/terminate-a-build/index.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

‎docs/builds/wait-for-a-build-condition/index.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

‎docs/compositions/create-a-composition/index.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

‎docs/compositions/delete-a-composition/index.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

‎docs/compositions/get-a-single-composition/index.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

‎docs/compositions/index.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

‎docs/compositions/replace-a-composition/index.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -278,18 +278,6 @@
278278
</li>
279279
</ul>
280280
</li>
281-
<li data-nav-id="/help/" class="dd-item">
282-
<a href="/help/">
283-
<span>Help</span><i class="fa fa-angle-right fa-lg category-icon"></i>
284-
</a>
285-
<ul>
286-
<li data-nav-id="/help/version/" class="dd-item">
287-
<a href="/help/version/">
288-
<span>Version</span>
289-
</a>
290-
</li>
291-
</ul>
292-
</li>
293281

294282

295283

0 commit comments

Comments
 (0)