Skip to content

Commit 75d78b3

Browse files
committed
Update example docs
Separated CI/CD examples into different topics; renamed examples to CD examples
1 parent b991111 commit 75d78b3

File tree

5 files changed

+66
-54
lines changed

5 files changed

+66
-54
lines changed

_data/home-content.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,6 @@
4545
icon: images/home-icons/tutorial.svg
4646
url: ''
4747
links:
48-
- title: CI/CD examples for pipelines
49-
localurl: /docs/example-catalog/examples/
5048
- title: CI examples
5149
localurl: /docs/example-catalog/ci-examples
5250
- title: CD examples

_data/nav.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,7 @@
4646
- title: Example catalog
4747
url: "/example-catalog"
4848
pages:
49-
- title: "CI/CD examples for pipelines"
50-
url: "/examples"
51-
- title: "CI examples"
49+
- title: CI examples
5250
url: "/ci-examples"
5351
sub-pages:
5452
- title: Check out Git repositories
@@ -115,7 +113,7 @@
115113
url: "/sending-the-notification-to-slack"
116114
- title: Send notification to Jira
117115
url: "/sending-the-notification-to-jira"
118-
- title: "CD examples"
116+
- title: CD examples
119117
url: "/cd-examples"
120118
sub-pages:
121119
- title: Import data to MongoDB
@@ -156,6 +154,9 @@
156154
url: "/amazon-ecs"
157155
- title: Elastic Beanstalk
158156
url: "/elastic-beanstalk"
157+
- title: GitOps examples
158+
url: "/cd-examples"
159+
159160
- title: Deployments
160161
url: "/deployments"
161162
pages:
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: "CD examples for pipelines"
3+
description: "A collection of CD examples for Codefresh pipelines"
4+
group: example-catalog
5+
toc: true
6+
---
7+
Codefresh enables you to define the steps of your pipeline in a [YAML file]({{site.baseurl}}/docs/pipelines/what-is-the-codefresh-yaml/). By default, the file is named `codefresh.yml`, and is located in the root directory of the repository.
8+
9+
This article focusses on CD examples for Codefresh pipelines.
10+
11+
12+
13+
## Preview environment examples
14+
15+
Codefresh can automatically launch environments (powered by Docker swarm) to [preview a Pull Reqest or feature]({{site.baseurl}}/docs/getting-started/on-demand-environments/). The definition of the environment can come from an [existing composition]({{site.baseurl}}/docs/testing/create-composition/), a docker-compose file or an inline YAML. Preview environments can be launched manually or [automatically from pipelines]({{site.baseurl}}/docs/pipelines/steps/launch-composition/).
16+
17+
- [MongoDB preload data]({{site.baseurl}}/docs/example-catalog/cd-examples/import-data-to-mongodb/)
18+
- [NodeJS + Angular2 + MongoDB]({{site.baseurl}}/docs/example-catalog/cd-examples/nodejs-angular2-mongodb/)
19+
- [NGINX Basic Auth]({{site.baseurl}}/docs/example-catalog/cd-examples/secure-a-docker-container-using-http-basic-auth/)
20+
- [Spring Boot + Kafka + Zookeeper]({{site.baseurl}}/docs/example-catalog/cd-examples/spring-boot-kafka-zookeeper/)
21+
- [Web terminal]({{site.baseurl}}/docs/example-catalog/cd-examples/web-terminal/)
22+
23+
## Deployment examples
24+
25+
Codefresh can deploy to any platform such as VMs, FTP/SSH/S3 sites, app servers, but of course it has great support for [Kubernetes clusters]({{site.baseurl}}/docs/deploy-to-kubernetes/deployment-options-to-kubernetes/) and [Helm releases]({{site.baseurl}}/docs/new-helm/helm-releases-management/):
26+
27+
- [Deploy to a VM with packer]({{site.baseurl}}/docs/example-catalog/cd-examples/packer-gcloud/)
28+
- [Deploy to a VM with FTP]({{site.baseurl}}/docs/example-catalog/cd-examples/transferring-php-ftp)
29+
- [Deploy to Tomcat using SCP]({{site.baseurl}}/docs/example-catalog/cd-examples/deploy-to-tomcat-via-scp)
30+
- [Deploy Demochat to a Kubernetes cluster]({{site.baseurl}}/docs/cd-examples/deploy-to-kubernetes/codefresh-kubernetes-integration-demochat-example/)
31+
- [Use kubectl as part of freestyle step]({{site.baseurl}}/docs/example-catalog/cd-examples/use-kubectl-as-part-of-freestyle-step)
32+
- [Deploy with Kustomize]({{site.baseurl}}/docs/example-catalog/cd-examples/deploy-with-kustomize)
33+
- [Deploy with Helm]({{site.baseurl}}/docs/example-catalog/cd-examples/helm)
34+
- [Deploy with Terraform]({{site.baseurl}}/docs/example-catalog/cd-examples/terraform)
35+
- [Deploy with Pulumi]({{site.baseurl}}/docs/example-catalog/cd-examples/pulumi)
36+
- [Deploy to Nomad]({{site.baseurl}}/docs/example-catalog/cd-examples/nomad)
37+
- [Deploy to Heroku]({{site.baseurl}}/docs/example-catalog/cd-examples/deploy-to-heroku/)
38+
- [Deploy to Docker swarm]({{site.baseurl}}/docs/example-catalog/cd-examples/docker-swarm/)
39+
- [Deploy to Elastic Beanstalk]({{site.baseurl}}/docs/example-catalog/cd-examples/elastic-beanstalk/)
40+
- [Deploy to Amazon ECS/Fargate]({{site.baseurl}}/docs/example-catalog/cd-examples/amazon-ecs/)
41+
42+
43+
## Related articles
44+
[CI examples for Codefresh pipelines]({{site.baseurl}}/docs/example-catalog/ci-examples)
45+
[GitOps examples]({{site.baseurl}}/docs/example-catalog/gitops-examples)
Lines changed: 15 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,16 @@
11
---
2-
title: "CI/CD pipeline examples"
3-
description: "A collection of examples for Codefresh pipelines"
2+
title: "CI examples for pipelines"
3+
description: "A collection of CI examples for Codefresh pipelines"
44
group: example-catalog
5-
redirect_from:
6-
- /docs/examples-v01/
7-
- examples.html
8-
- /docs/catalog-examples/
9-
- /docs/examples/
10-
- /docs/pipelines-examples/
11-
- /docs/pipelines/pipelines-examples/
125
toc: true
136
---
147
Codefresh enables you to define the steps of your pipeline in a [YAML file]({{site.baseurl}}/docs/pipelines/what-is-the-codefresh-yaml/). By default, the file is named `codefresh.yml`, and is located in the root directory of the repository.
158

16-
## CI examples
9+
This article focusses on CI examples.
1710

18-
### Programming-language specific examples
11+
12+
13+
## Programming-language specific examples
1914

2015
Codefresh is agnostic as far as programming languages are concerned. All major programming languages are supported:
2116

@@ -31,15 +26,15 @@ Codefresh is agnostic as far as programming languages are concerned. All major p
3126
- [Scala App]({{site.baseurl}}/docs/example-catalog/ci-examples/scala-hello-world/)
3227
- [Android (Mobile)]({{site.baseurl}}/docs/example-catalog/ci-examples/android/)
3328

34-
### Source code checkout examples
29+
## Check out source code examples
3530

3631
You can check out code from one or more repositories in any pipeline phase. Codefresh includes [built-in GIT integration]({{site.baseurl}}/docs/integrations/git-providers/) with all the popular GIT providers and can be used with [git-clone]({{site.baseurl}}/docs/pipelines/steps/git-clone/) steps.
3732

3833
- [Cloning Git repositories using the built-in integration]({{site.baseurl}}/docs/example-catalog/ci-examples/git-checkout/)
3934
- [Cloning Git repositories using manual Git commands]({{site.baseurl}}/docs/example-catalog/ci-examples/git-checkout-custom/)
4035
- [Checking out from Subversion, Perforce, Mercurial, etc ]({{site.baseurl}}/docs/example-catalog/ci-examples/non-git-checkout/)
4136

42-
### Build/push examples
37+
## Build/push examples
4338

4439
Codefresh has native support for [building]({{site.baseurl}}/docs/pipelines/steps/build/) and [pushing]({{site.baseurl}}/docs/pipelines/steps/push/) Docker containers.
4540
You can also compile traditional applications that are not Dockerized yet.
@@ -56,7 +51,7 @@ You can also compile traditional applications that are not Dockerized yet.
5651
- [Trigger a Kubernetes Deployment from a Dockerhub Push Event]({{site.baseurl}}/docs/example-catalog/ci-examples/trigger-a-k8s-deployment-from-docker-registry/)
5752

5853
<!--ask Kostis about these -->
59-
### Unit and integration test examples
54+
## Unit and integration testing examples
6055

6156
Codefresh has support for both [unit]({{site.baseurl}}/docs/testing/unit-tests/) and [integration tests]({{site.baseurl}}/docs/testing/integration-tests/) as well as [test reporting]({{site.baseurl}}/docs/testing/test-reports/).
6257

@@ -73,55 +68,28 @@ Codefresh has support for both [unit]({{site.baseurl}}/docs/testing/unit-tests/)
7368
- [Launch Composition and define Service Environment variables using a file]({{site.baseurl}}/docs/example-catalog/ci-examples/launching-a-composition-and-defining-a-service-environment-variables-using-a-file)
7469
- [Run multiple kinds of unit tests using fan-in-fan-out parallel pipeline]({{site.baseurl}}/docs/example-catalog/fan-in-fan-out)
7570

76-
### Code coverage examples
71+
## Code coverage examples
7772

7873
- [Run coverage reports with Codecov]({{site.baseurl}}/docs/example-catalog/ci-examples/codecov-testing)
7974
- [Run coverage reports with Coveralls]({{site.baseurl}}/docs/example-catalog/ci-examples/coveralls-testing)
8075
- [Run coverage reports with Codacy]({{site.baseurl}}/docs/example-catalog/ci-examples/codacy-testing)
8176

82-
### Secrets examples
77+
## Secrets examples
8378

8479
Codefresh can automatically export secret key-value pairs using the Vault plugin from the [Step Marketplace](https://codefresh.io/steps/step/vault).
8580

8681
- [Vault secrets in the Pipeline]({{site.baseurl}}/docs/example-catalog/ci-examples/vault-secrets-in-the-pipeline)
8782
- [Decryption with Mozilla SOPS]({{site.baseurl}}/docs/example-catalog/ci-examples/ci-examples/decryption-with-mozilla-sops)
8883
- [GitOps with Bitnami sealed secrets]({{site.baseurl}}/docs/example-catalog/ci-examples/gitops-secrets)
8984

90-
### Notification examples
85+
## Notification examples
9186

9287
- [Send notification to Slack]({{site.baseurl}}/docs/example-catalog/ci-examples/sending-the-notification-to-slack)
9388
- [Send notification to Jira]({{site.baseurl}}/docs/example-catalog/ci-examples/sending-the-notification-to-jira)
9489

9590

96-
## CD examples
97-
98-
### Preview environment examples
99-
100-
Codefresh can automatically launch environments (powered by Docker swarm) to [preview a Pull Reqest or feature]({{site.baseurl}}/docs/getting-started/on-demand-environments/). The definition of the environment can come from an [existing composition]({{site.baseurl}}/docs/testing/create-composition/), a docker-compose file or an inline YAML. Preview environments can be launched manually or [automatically from pipelines]({{site.baseurl}}/docs/pipelines/steps/launch-composition/).
101-
102-
- [MongoDB preload data]({{site.baseurl}}/docs/example-catalog/cd-examples/import-data-to-mongodb/)
103-
- [NodeJS + Angular2 + MongoDB]({{site.baseurl}}/docs/example-catalog/cd-examples/nodejs-angular2-mongodb/)
104-
- [NGINX Basic Auth]({{site.baseurl}}/docs/example-catalog/cd-examples/secure-a-docker-container-using-http-basic-auth/)
105-
- [Spring Boot + Kafka + Zookeeper]({{site.baseurl}}/docs/example-catalog/cd-examples/spring-boot-kafka-zookeeper/)
106-
- [Web terminal]({{site.baseurl}}/docs/example-catalog/cd-examples/web-terminal/)
107-
108-
### Deployment examples
109-
110-
Codefresh can deploy to any platform such as VMs, FTP/SSH/S3 sites, app servers, but of course it has great support for [Kubernetes clusters]({{site.baseurl}}/docs/deploy-to-kubernetes/deployment-options-to-kubernetes/) and [Helm releases]({{site.baseurl}}/docs/new-helm/helm-releases-management/):
111-
112-
- [Deploy to a VM with packer]({{site.baseurl}}/docs/example-catalog/cd-examples/packer-gcloud/)
113-
- [Deploy to a VM with FTP]({{site.baseurl}}/docs/example-catalog/cd-examples/transferring-php-ftp)
114-
- [Deploy to Tomcat using SCP]({{site.baseurl}}/docs/example-catalog/cd-examples/deploy-to-tomcat-via-scp)
115-
- [Deploy Demochat to a Kubernetes cluster]({{site.baseurl}}/docs/cd-examples/deploy-to-kubernetes/codefresh-kubernetes-integration-demochat-example/)
116-
- [Use kubectl as part of freestyle step]({{site.baseurl}}/docs/example-catalog/cd-examples/use-kubectl-as-part-of-freestyle-step)
117-
- [Deploy with Kustomize]({{site.baseurl}}/docs/example-catalog/cd-examples/deploy-with-kustomize)
118-
- [Deploy with Helm]({{site.baseurl}}/docs/example-catalog/cd-examples/helm)
119-
- [Deploy with Terraform]({{site.baseurl}}/docs/example-catalog/cd-examples/terraform)
120-
- [Deploy with Pulumi]({{site.baseurl}}/docs/example-catalog/cd-examples/pulumi)
121-
- [Deploy to Nomad]({{site.baseurl}}/docs/example-catalog/cd-examples/nomad)
122-
- [Deploy to Heroku]({{site.baseurl}}/docs/example-catalog/cd-examples/deploy-to-heroku/)
123-
- [Deploy to Docker swarm]({{site.baseurl}}/docs/example-catalog/cd-examples/docker-swarm/)
124-
- [Deploy to Elastic Beanstalk]({{site.baseurl}}/docs/example-catalog/cd-examples/elastic-beanstalk/)
125-
- [Deploy to Amazon ECS/Fargate]({{site.baseurl}}/docs/example-catalog/cd-examples/amazon-ecs/)
12691

12792

93+
## Related articles
94+
[CD examples for Codefresh pipelines]({{site.baseurl}}/docs/example-catalog/cd-examples)
95+
[GitOps examples]({{site.baseurl}}/docs/example-catalog/gitops-examples)

_docs/example-catalog/gitops-example.md renamed to _docs/example-catalog/gitops-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "GitOps examples"
2+
title: "GitOps examples for deployments"
33
description: "A collection of examples for GitOps deployments"
44
group: example-catalog
55
sub_group: gitops-examples

0 commit comments

Comments
 (0)