Skip to content

Commit a5d5297

Browse files
Itai GendlerItai Gendler
Itai Gendler
authored and
Itai Gendler
committed
Update documentation
1 parent 19dad16 commit a5d5297

File tree

57 files changed

+783
-647
lines changed

Some content is hidden

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

57 files changed

+783
-647
lines changed

‎docs-template/content/_header.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title = "header"
33
description = ""
44
date = "2017-04-24T18:36:24+02:00"
55
+++
6-
Codefresh CLI Documentation
6+
[Codefresh CLI](/)

‎docs-template/content/_index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
---
2-
weight: 10
3-
title: Introduction
4-
---
1+
+++
2+
description = "Codefresh CLI"
3+
date = "2017-04-24T18:36:24+02:00"
4+
weight = 1
5+
+++
6+
7+
# Codefresh CLI
58

6-
# Introduction
79
Welcome to Codefresh's official CLI documentation!
810

911
Codefresh CLI provides a full and flexible interface to interact with Codefresh.<br>
@@ -13,3 +15,5 @@ The CLI can be used to achieve the following:
1315
<li>Create complex automations from your local machine</li>
1416
<li>Run complex pipeline use cases by using the CLI inside your pipeline steps</li>
1517
</ul>
18+
19+
To get started please navigate to [Getting started](/getting-started) page

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
+++
22
title = "Authentication"
3-
description = "asd"
3+
description = ""
44
date = "2017-04-24T18:36:24+02:00"
55
+++
6-
7-
## Basic Usage
8-
In order to start working with the cli you will need to update the authentication configuration. <br />
9-
Generate a new API key through the <a href="https://g.codefresh.io/account/tokens" target="_blank">account settings</a> page.
10-
11-
Once you have the API key, create a new authentication context:<br> `codefresh auth create-context --api-key {API_KEY}`
12-
13-
## Advanced Usage

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

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

8-
Welcome to Codefresh's official CLI documentation!
8+
## install
9+
Install the CLI through one of the possible ways described in the [Installation](/installation) page
910

10-
Codefresh CLI provides a full and flexible interface to interact with Codefresh.<br>
11-
The CLI can be used to achieve the following:
12-
<ul>
13-
<li>Perform any opeartion you would be able to do through the UI</li>
14-
<li>Create complex automations from your local machine</li>
15-
<li>Run complex pipeline use cases by using the CLI inside your pipeline steps</li>
16-
</ul>
11+
## authenticate
12+
In order to start working with the cli you will need to update the authentication configuration. <br />
13+
Updating the authentication configuration is done via an API-KEY you generate from Codefresh. <br />
14+
15+
If you already have an API-KEY you can just use it.<br />
16+
You can generate a new one from the <a href="https://g.codefresh.io/account/tokens" target="_blank">account settings</a> page. <br />
17+
{{% alert theme="warning" %}}You must be an account admin to generate api keys{{% /alert %}}
18+
19+
Once you have an API key, create a new authentication context:<br> `codefresh auth create-context --api-key {API_KEY}`
20+
21+
<br />
22+
#### That's it, you are go to go!

‎docs-template/content/installation/docker.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title = "Docker Image"
33
description = ""
44
date = "2017-04-24T18:36:24+02:00"
5+
weight = 30
56
+++
67

78
You can run the CLI using our official docker image which is published to <a href="https://hub.docker.com/r/codefresh/cli/" target="_blank">Dockerhub</a><br>

‎docs-template/content/installation/download.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title = "Download"
33
description = ""
44
date = "2017-04-24T18:36:24+02:00"
5+
weight = 40
56
+++
67

78
Navigate to <a href="https://github.com/codefresh-io/cli/releases" target="_blank">Official Releases</a>

‎docs-template/content/installation/npm.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22
title = "NPM"
33
description = ""
44
date = "2017-04-24T18:36:24+02:00"
5+
weight = 10
56
+++
67

7-
Codefresh's cli is available for installation through NPM registry.
8+
{{% alert theme="warning" %}}the CLI requires node version 8.0.0 or higer{{% /alert %}}
9+
10+
Codefresh's CLI is available for installation through NPM registry.
811

912
Install:
1013
`npm install -g codefresh`

‎docs-template/content/installation/yarn.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@
22
title = "YARN"
33
description = ""
44
date = "2017-04-24T18:36:24+02:00"
5+
weight = 20
56
+++
67

8+
{{% alert theme="warning" %}}the CLI requires node version 8.0.0 or higer{{% /alert %}}
9+
10+
Codefresh's CLI is available for installation using YARN.
11+
712
Install:
813
`yarn global add codefresh`
914

‎docs/404.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242

4343

44-
<p>Codefresh CLI Documentation</p>
44+
<p><a href="/">Codefresh CLI</a></p>
4545

4646

4747

@@ -59,16 +59,6 @@
5959
<span>Installation</span><i class="fa fa-angle-right fa-lg category-icon"></i>
6060
</a>
6161
<ul>
62-
<li data-nav-id="/installation/docker/" class="dd-item">
63-
<a href="/installation/docker/">
64-
<span>Docker Image</span>
65-
</a>
66-
</li>
67-
<li data-nav-id="/installation/download/" class="dd-item">
68-
<a href="/installation/download/">
69-
<span>Download</span>
70-
</a>
71-
</li>
7262
<li data-nav-id="/installation/npm/" class="dd-item">
7363
<a href="/installation/npm/">
7464
<span>NPM</span>
@@ -78,6 +68,16 @@
7868
<a href="/installation/yarn/">
7969
<span>YARN</span>
8070
</a>
71+
</li>
72+
<li data-nav-id="/installation/docker/" class="dd-item">
73+
<a href="/installation/docker/">
74+
<span>Docker Image</span>
75+
</a>
76+
</li>
77+
<li data-nav-id="/installation/download/" class="dd-item">
78+
<a href="/installation/download/">
79+
<span>Download</span>
80+
</a>
8181
</li>
8282
</ul>
8383
</li>

‎docs/_header/index.html

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242

4343

44-
<p>Codefresh CLI Documentation</p>
44+
<p><a href="/">Codefresh CLI</a></p>
4545

4646

4747

@@ -59,16 +59,6 @@
5959
<span>Installation</span><i class="fa fa-angle-right fa-lg category-icon"></i>
6060
</a>
6161
<ul>
62-
<li data-nav-id="/installation/docker/" class="dd-item">
63-
<a href="/installation/docker/">
64-
<span>Docker Image</span>
65-
</a>
66-
</li>
67-
<li data-nav-id="/installation/download/" class="dd-item">
68-
<a href="/installation/download/">
69-
<span>Download</span>
70-
</a>
71-
</li>
7262
<li data-nav-id="/installation/npm/" class="dd-item">
7363
<a href="/installation/npm/">
7464
<span>NPM</span>
@@ -78,6 +68,16 @@
7868
<a href="/installation/yarn/">
7969
<span>YARN</span>
8070
</a>
71+
</li>
72+
<li data-nav-id="/installation/docker/" class="dd-item">
73+
<a href="/installation/docker/">
74+
<span>Docker Image</span>
75+
</a>
76+
</li>
77+
<li data-nav-id="/installation/download/" class="dd-item">
78+
<a href="/installation/download/">
79+
<span>Download</span>
80+
</a>
8181
</li>
8282
</ul>
8383
</li>
@@ -329,7 +329,7 @@
329329

330330

331331

332-
<a href='/'>Introduction</a> > header
332+
<a href='/'></a> > header
333333

334334

335335

@@ -358,7 +358,7 @@ <h1>header</h1>
358358

359359

360360

361-
<p>Codefresh CLI Documentation</p>
361+
<p><a href="/">Codefresh CLI</a></p>
362362

363363

364364

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242

4343

44-
<p>Codefresh CLI Documentation</p>
44+
<p><a href="/">Codefresh CLI</a></p>
4545

4646

4747

@@ -59,16 +59,6 @@
5959
<span>Installation</span><i class="fa fa-angle-right fa-lg category-icon"></i>
6060
</a>
6161
<ul>
62-
<li data-nav-id="/installation/docker/" class="dd-item">
63-
<a href="/installation/docker/">
64-
<span>Docker Image</span>
65-
</a>
66-
</li>
67-
<li data-nav-id="/installation/download/" class="dd-item">
68-
<a href="/installation/download/">
69-
<span>Download</span>
70-
</a>
71-
</li>
7262
<li data-nav-id="/installation/npm/" class="dd-item">
7363
<a href="/installation/npm/">
7464
<span>NPM</span>
@@ -78,6 +68,16 @@
7868
<a href="/installation/yarn/">
7969
<span>YARN</span>
8070
</a>
71+
</li>
72+
<li data-nav-id="/installation/docker/" class="dd-item">
73+
<a href="/installation/docker/">
74+
<span>Docker Image</span>
75+
</a>
76+
</li>
77+
<li data-nav-id="/installation/download/" class="dd-item">
78+
<a href="/installation/download/">
79+
<span>Download</span>
80+
</a>
8181
</li>
8282
</ul>
8383
</li>
@@ -333,7 +333,7 @@
333333

334334

335335

336-
<a href='/'>Introduction</a> > <a href='/authentication/'>Authentication</a> > Create authentication context
336+
<a href='/'></a> > <a href='/authentication/'>Authentication</a> > Create authentication context
337337

338338

339339

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242

4343

44-
<p>Codefresh CLI Documentation</p>
44+
<p><a href="/">Codefresh CLI</a></p>
4545

4646

4747

@@ -59,16 +59,6 @@
5959
<span>Installation</span><i class="fa fa-angle-right fa-lg category-icon"></i>
6060
</a>
6161
<ul>
62-
<li data-nav-id="/installation/docker/" class="dd-item">
63-
<a href="/installation/docker/">
64-
<span>Docker Image</span>
65-
</a>
66-
</li>
67-
<li data-nav-id="/installation/download/" class="dd-item">
68-
<a href="/installation/download/">
69-
<span>Download</span>
70-
</a>
71-
</li>
7262
<li data-nav-id="/installation/npm/" class="dd-item">
7363
<a href="/installation/npm/">
7464
<span>NPM</span>
@@ -78,6 +68,16 @@
7868
<a href="/installation/yarn/">
7969
<span>YARN</span>
8070
</a>
71+
</li>
72+
<li data-nav-id="/installation/docker/" class="dd-item">
73+
<a href="/installation/docker/">
74+
<span>Docker Image</span>
75+
</a>
76+
</li>
77+
<li data-nav-id="/installation/download/" class="dd-item">
78+
<a href="/installation/download/">
79+
<span>Download</span>
80+
</a>
8181
</li>
8282
</ul>
8383
</li>
@@ -333,7 +333,7 @@
333333

334334

335335

336-
<a href='/'>Introduction</a> > <a href='/authentication/'>Authentication</a> > Get activated context
336+
<a href='/'></a> > <a href='/authentication/'>Authentication</a> > Get activated context
337337

338338

339339

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242

4343

44-
<p>Codefresh CLI Documentation</p>
44+
<p><a href="/">Codefresh CLI</a></p>
4545

4646

4747

@@ -59,16 +59,6 @@
5959
<span>Installation</span><i class="fa fa-angle-right fa-lg category-icon"></i>
6060
</a>
6161
<ul>
62-
<li data-nav-id="/installation/docker/" class="dd-item">
63-
<a href="/installation/docker/">
64-
<span>Docker Image</span>
65-
</a>
66-
</li>
67-
<li data-nav-id="/installation/download/" class="dd-item">
68-
<a href="/installation/download/">
69-
<span>Download</span>
70-
</a>
71-
</li>
7262
<li data-nav-id="/installation/npm/" class="dd-item">
7363
<a href="/installation/npm/">
7464
<span>NPM</span>
@@ -78,6 +68,16 @@
7868
<a href="/installation/yarn/">
7969
<span>YARN</span>
8070
</a>
71+
</li>
72+
<li data-nav-id="/installation/docker/" class="dd-item">
73+
<a href="/installation/docker/">
74+
<span>Docker Image</span>
75+
</a>
76+
</li>
77+
<li data-nav-id="/installation/download/" class="dd-item">
78+
<a href="/installation/download/">
79+
<span>Download</span>
80+
</a>
8181
</li>
8282
</ul>
8383
</li>
@@ -333,7 +333,7 @@
333333

334334

335335

336-
<a href='/'>Introduction</a> > <a href='/authentication/'>Authentication</a> > Get all contexts
336+
<a href='/'></a> > <a href='/authentication/'>Authentication</a> > Get all contexts
337337

338338

339339

0 commit comments

Comments
 (0)