Skip to content

Commit 92ebee6

Browse files
Itai GendlerItai Gendler
authored andcommitted
Update documentation
1 parent 3fd67e5 commit 92ebee6

File tree

68 files changed

+5594
-4035
lines changed

Some content is hidden

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

68 files changed

+5594
-4035
lines changed

docs-template/.gitmodules

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
+++
22
title = "Authentication"
3-
description = ""
43
date = "2017-04-24T18:36:24+02:00"
4+
weight = 30
55
+++
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
+++
22
title = "Builds"
3-
+++
3+
weight = 70
4+
+++
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
+++
22
title = "Compositions"
3-
+++
3+
weight = 90
4+
+++
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
+++
22
title = "Contexts"
3-
+++
3+
weight = 40
4+
+++
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
+++
22
title = "Environments"
3-
+++
3+
weight = 100
4+
+++

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title = "Getting Started"
33
description = ""
44
date = "2017-04-24T18:36:24+02:00"
5-
weight = 1
5+
weight = 10
66
+++
77

88
## install
@@ -18,5 +18,6 @@ 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+
2122
<br />
22-
#### That's it, you are go to go!
23+
#### That's it, you are good to go!

docs-template/content/help/_index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
+++
2+
title = "Help"
3+
description = ""
4+
date = "2017-04-24T18:36:24+02:00"
5+
weight = 1000
6+
+++
7+
8+
To get help and usage instructions you can run `codefresh --help`.<br />
9+
A help message will appear in the terminal.<br />
10+
11+
You can also run `--help` on any possible command to get specific help for a command.<br />
12+
For example: `codefresh get pipelines --help` will show help information for getting pipelines.
13+

docs-template/content/help/version.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
+++
2+
title = "Version"
3+
description = ""
4+
date = "2017-04-24T18:36:24+02:00"
5+
weight = 10
6+
+++
7+
8+
Run `codefresh version` to see the current CLI version.
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
+++
22
title = "Images"
3-
+++
3+
weight = 80
4+
+++
Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
+++
22
title = "Installation"
33
description = ""
4-
date = "2017-04-24T18:36:24+02:00"
5-
weight = 2
4+
weight = 20
65
+++
76

8-
Codefresh CLI is developed and built with node.js.
9-
In case you have node.js installed on your machine you can use npm or yarn to install it.<br>
10-
If you don't have node.js installed you can install the CLI by downloading a binary.
7+
Codefresh CLI is developed and built with node.js. <br />
8+
9+
In case you have node.js installed on your machine you can use [NPM](/installation/npm) or [YARN](/installation/yarn) to install it.<br>
10+
11+
If you don't have node.js installed you can install the CLI by [Donwloading](/installation/download) it directly.<br />
12+
13+
It is also possible to run the CLI using a [Docker image](/installation/docker).

docs-template/content/installation/docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
+++
22
title = "Docker Image"
3-
description = ""
3+
description = "asdsd"
44
date = "2017-04-24T18:36:24+02:00"
55
weight = 30
66
+++

docs-template/content/installation/download.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
+++
22
title = "Download"
3-
description = ""
3+
description = "asd"
44
date = "2017-04-24T18:36:24+02:00"
55
weight = 40
66
+++

docs-template/content/installation/npm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
+++
22
title = "NPM"
3-
description = ""
3+
description = "asd"
44
date = "2017-04-24T18:36:24+02:00"
55
weight = 10
66
+++

docs-template/content/installation/yarn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
+++
22
title = "YARN"
3-
description = ""
3+
description = "asd"
44
date = "2017-04-24T18:36:24+02:00"
55
weight = 20
66
+++
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
+++
22
title = "Pipelines"
3-
+++
3+
weight = 50
4+
+++
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
+++
22
title = "Predefined Pipelines"
3-
+++
3+
weight = 60
4+
+++

docs-template/themes/docuapi

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)