Skip to content

Commit

Permalink
- docs renamed to _docs, created jekyll collection
Browse files Browse the repository at this point in the history
- updated how-to-use.md
- added default permalinks for collections posts/pages/docs
- added Plugins link into docs-navbar.html
  • Loading branch information
elartix committed Feb 21, 2018
1 parent 4d33fd6 commit 0e9884e
Show file tree
Hide file tree
Showing 217 changed files with 255 additions and 285 deletions.
13 changes: 9 additions & 4 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,15 @@ repository: codefresh-io/docs.codefresh.io

# Collections
collections:
docs:
posts:
output: true
permalink: /:collection/:year/:month/:day/:title/
pages:
output: true
permalink: /:name
permalink: /:collection/:path
docs:
output: true
permalink: /:collection/:path/

# Defaults
defaults:
Expand All @@ -94,9 +98,9 @@ defaults:
type: pages
values:
layout: simple
# docs
# _docs
- scope:
path: "docs"
path: "_docs"
type: docs
values:
layout: docs
Expand All @@ -115,6 +119,7 @@ link_main: "http://codefresh.io"
link_cli: "http://cli.codefresh.io"
link_git_examples: "https://github.com/codefresh-examples/examples/"
link_api: "https://g.codefresh.io/api/"
link_plugins: "https://github.com/codefresh-io/plugins"

ga_tracking_code: "UA-112283329-1"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ title: "Invite your team members"
description: ""
group: accounts
redirect_from:
- /docs/invite-your-team-member
- /docs/accounts
- /docs/accounts/
toc: true
---
Follow these steps to add collaborators to your account.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Contribute Codefresh Plugin"
description: ""
group: codefresh-plugins
redirect_from:
- /docs/contribute-codefresh-plugin
- /docs/contribute-codefresh-plugin/
toc: true
---
We'd love for you to contribute a Plugin that provides a useful automated step for Codefresh.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Plugins"
description: ""
group: codefresh-plugins
redirect_from:
- /docs/plugins
- /docs/plugins/
- /docs/codefresh-plugins/
toc: true
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@ layout: docs
title: "Codefresh inline YAML"
description: ""
group: codefresh-yaml
permalink: /:path/codefresh-inline-yaml/
redirect_from:
- /docs/inline-yaml-editing
- /docs/inline-yaml-editing/
toc: true
---
Codefresh allows you to select between several options for YAML origin. You can use a codefresh YAML from your repository or Create and edit a new YAML inline.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ title: "Examples"
description: ""
group: codefresh-yaml
redirect_from:
- /docs/examples
- /docs/codefresh-yaml-examples
- /docs/examples/
- /docs/codefresh-yaml-examples/
toc: true
old: /docs/examples
was_hidden: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Conditional Execution of Steps"
description: ""
group: codefresh-yaml
redirect_from:
- /docs/conditional-execution-of-steps
- /docs/conditional-execution-of-steps/
toc: true
---
For each step in a ```codefresh.yml``` file, you can define a set of conditions which need to be satisfied in order to execute the step. (An introduction to the ```codefresh.yml``` file can be found [here]({{ site.baseurl }}/docs/codefresh-yaml/what-is-the-codefresh-yaml/).)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Execution Flow"
description: ""
group: codefresh-yaml
redirect_from:
- /docs/execution-flow
- /docs/execution-flow/
toc: true
---
Execution of a Codefresh YAML is comprised of several consecutive phases:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Expression Condition Syntax"
description: ""
group: codefresh-yaml
redirect_from:
- /docs/expression-condition-syntax
- /docs/expression-condition-syntax/
toc: true
---
Each step in `codefresh.yml` file can contain expression conditions that must be satisfied for the step to execute.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "In Depth"
description: ""
group: codefresh-yaml
redirect_from:
- /docs/in-depth
- /docs/in-depth/
toc: true
old: /docs/in-depth
was_hidden: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@ layout: docs
title: "Image Metadata Annotations"
description: ""
group: codefresh-yaml
permalink: /:path/metadata-annotations/
redirect_from:
- /docs/metadata-annotations
- /docs/metadata-annotations/
toc: true
---
Images built by Codefresh can be annotated with customized metadata.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Post-Step Operations"
description: ""
group: codefresh-yaml
redirect_from:
- /docs/post-step-operations
- /docs/post-step-operations/
toc: true
---
Post-step operations are a set of optional predefined processes that can be configured on any step. These operations will be executed once the step has completed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Steps"
description: ""
group: codefresh-yaml
redirect_from:
- /docs/steps
- /docs/steps/
toc: true
---
A step may be **typed** or **untyped**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: codefresh-yaml
sub_group: steps
redirect_from:
- /docs/build-1
- /docs/build-1/
toc: true
---
Use Docker to build an image and store it in Codefresh.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: codefresh-yaml
sub_group: steps
redirect_from:
- /docs/composition-1
- /docs/composition-1/
toc: true
---
The composition step runs a Docker Composition as a means to execute finite commands in a more complex interaction of services.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: codefresh-yaml
sub_group: steps
redirect_from:
- /docs/deploy
- /docs/deploy/
toc: true
---
Deploy step can be used as a step to deploy build image to user's cluster
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: codefresh-yaml
sub_group: steps
redirect_from:
- /docs/freestyle-beta
- /docs/freestyle-beta/
toc: true
old_url: /docs/freestyle-beta
was_hidden: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: codefresh-yaml
sub_group: steps
redirect_from:
- /docs/freestyle
- /docs/freestyle/
toc: true
---
The Freestyle step is designed so you can execute a series of commands in a container.
Expand All @@ -17,11 +17,12 @@ If you do not specify a working directory or commands, the step runs the organic
`YAML`
{% highlight yaml %}
{% raw %}
step_name:
title: Step Title
description: Step description
image: image/id
working_directory: {% raw %}${{step_id}}{% endraw %}
working_directory: ${{step_id}}
commands:
- bash-command1
- bash-command2
Expand All @@ -37,6 +38,7 @@ step_name:
...
on_finish:
...
{% endraw %}
{% endhighlight %}

**Fields:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: codefresh-yaml
sub_group: steps
redirect_from:
- /docs/git-clone
- /docs/git-clone/
toc: true
---
Clones a Git repository to the filesystem.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: codefresh-yaml
sub_group: steps
redirect_from:
- /docs/integration-test
- /docs/integration-test/
toc: true
old_url: /docs/integration-test
was_hidden: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: codefresh-yaml
sub_group: steps
redirect_from:
- /docs/launch-composition-2
- /docs/launch-composition-2/
toc: true
---
The launch composition step provides the ability to launch long term running environment that can live outside the context of the running flow.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: codefresh-yaml
sub_group: steps
redirect_from:
- /docs/push-1
- /docs/push-1/
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Variables"
description: ""
group: codefresh-yaml
redirect_from:
- /docs/variables
- /docs/variables/
toc: true
---
Variables in the YAML follow this format: {% raw %}`${{VAR_NAME}}`{% endraw %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ layout: docs
title: "Introduction"
description: ""
group: codefresh-yaml
permalink: /:path/what-is-the-codefresh-yaml/
redirect_from:
- /docs/what-is-the-codefresh-yaml
- /docs/codefresh-yaml/
toc: true
---
Quick example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Working Directories"
description: ""
group: codefresh-yaml
redirect_from:
- /docs/working-directories
- /docs/working-directories/
toc: true
---
In the context of a step, a working directory can be of the following type:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Build badges-old"
description: ""
group: configure-ci-cd-pipeline
redirect_from:
- /docs/build-badges-old
- /docs/build-badges-old/
toc: true
old_url: /docs/build-badges-old
was_hidden: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ layout: docs
title: "Build badges"
description: ""
group: configure-ci-cd-pipeline
permalink: /:path/build-status/
redirect_from:
- /docs/build-status
toc: true
---
## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Integration Tests"
description: ""
group: configure-ci-cd-pipeline
redirect_from:
- /docs/integration-tests
- /docs/integration-tests/
toc: true
---
If your service is part of a micro-services type of application, Codefresh enables you to run your image as part of a composition, and then run your integration tests against it. There are two pre-requisites for this step:
Expand Down Expand Up @@ -45,6 +45,6 @@ Follow these steps to run the the integration test
* at the moment it is not possible to control other docker-compose fields for the test image service.

<div class="bd-callout bd-callout-info" markdown="1">
If you have a more complicated scenario, you can use the [Codefresh YAML](https://docs.codefresh.io/docs/what-is-the-codefresh-yaml){:target="_blank"} to define your pipeline
If you have a more complicated scenario, you can use the [Codefresh YAML]({{ site.baseurl }}/docs/codefresh-yaml/what-is-the-codefresh-yaml/){:target="_blank"} to define your pipeline
</div>

Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ title: "Introduction to Codefresh pipelines"
description: ""
group: configure-ci-cd-pipeline
redirect_from:
- /docs/introduction-to-codefresh-pipelines
- /docs/configure-ci-cd-pipeline
- /docs/introduction-to-codefresh-pipelines/
- /docs/configure-ci-cd-pipeline/
toc: true
---
### What are Codefresh pipelines?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Push an image to a Docker registry"
description: ""
group: configure-ci-cd-pipeline
redirect_from:
- /docs/push-image-to-a-docker-registry
- /docs/push-image-to-a-docker-registry/
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Unit Tests"
description: ""
group: configure-ci-cd-pipeline
redirect_from:
- /docs/setup-unit-tests
- /docs/setup-unit-tests/
toc: true
---
With Codefresh, you can easily set your unit tests to run on every build.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: configure-ci-cd-pipeline
sub_group: unit-tests
redirect_from:
- /docs/run-unit-tests-with-db-composition
- /docs/run-unit-tests-with-db-composition/
toc: true
old_url: /docs/run-unit-tests-with-db-composition
was_hidden: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: configure-ci-cd-pipeline
sub_group: unit-tests
redirect_from:
- /docs/setup-unit-tests
- /docs/setup-unit-tests/
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: configure-ci-cd-pipeline
sub_group: unit-tests
redirect_from:
- /docs/unit-tests-with-database
- /docs/unit-tests-with-database/
toc: true
---
Sometimes running unit tests requires some additional services like a Database (Mongo, MySql, Postgres etc), or third-party components like Redis, Memcache, etc.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: configure-ci-cd-pipeline
sub_group: unit-tests
redirect_from:
- /docs/nodejsmongo
- /docs/nodejsmongo/
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: ""
group: configure-ci-cd-pipeline
sub_group: unit-tests
redirect_from:
- /docs/nodejsmysql
- /docs/nodejsmysql/
toc: true
---

Expand Down
Loading

0 comments on commit 0e9884e

Please sign in to comment.