Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
Signed-off-by: Yvonnick Esnault <yvonnick.esnault@corp.ovh.com>
  • Loading branch information
yesnault committed Mar 11, 2019
1 parent 36c20e3 commit 3db8b68
Show file tree
Hide file tree
Showing 1,074 changed files with 71,050 additions and 108,531 deletions.
2 changes: 1 addition & 1 deletion Makefile
Expand Up @@ -6,7 +6,7 @@ doc:
ifndef GEN_PATH
$(error GEN_PATH is undefined)
endif
# export GEN_PATH=$HOME/src/github.com/ovh/cds/docs/content/manual/components
# export GEN_PATH=$HOME/src/github.com/ovh/cds/docs/content/docs/components
$(TARGET_CDSCTL) doc $(GEN_PATH)
$(TARGET_WORKER) doc $(GEN_PATH)
$(TARGET_ENGINE) doc $(GEN_PATH) ./
Expand Down
20 changes: 10 additions & 10 deletions README.md
Expand Up @@ -48,18 +48,18 @@ Docker-Compose or Helm are your friends, see [Ready To Run Tutorials](https://ov

### Why CDS? Discover the Origins

- [Self-Service](https://ovh.github.io/cds/gettingstarted/concepts/why_cds/#1-self-service)
- [Horizontal Scalability](https://ovh.github.io/cds/gettingstarted/concepts/why_cds/#2-horizontal-scalability)
- [High Availability](https://ovh.github.io/cds/gettingstarted/concepts/why_cds/#3-high-availability)
- [Pipeline Reutilisability](https://ovh.github.io/cds/gettingstarted/concepts/why_cds/#4-pipeline-reutilisability)
- [Rest API](https://ovh.github.io/cds/gettingstarted/concepts/why_cds/#5-rest-api)
- [Customizable](https://ovh.github.io/cds/gettingstarted/concepts/why_cds/#6-customizable)
- [Self-Service](https://ovh.github.io/cds/about/why_cds/#1-self-service)
- [Horizontal Scalability](https://ovh.github.io/cds/about/why_cds/#2-horizontal-scalability)
- [High Availability](https://ovh.github.io/cds/about/why_cds/#3-high-availability)
- [Pipeline Reutilisability](https://ovh.github.io/cds/about/why_cds/#4-pipeline-reutilisability)
- [Rest API](https://ovh.github.io/cds/about/why_cds/#5-rest-api)
- [Customizable](https://ovh.github.io/cds/about/why_cds/#6-customizable)

### What is a CDS workflow?

Most of the CI/CD Tools play with jobs inside a pipeline. CDS introduce a new concept named `CDS Workflows`.
A [CDS Workflow](https://ovh.github.io/cds/gettingstarted/concepts/workflow/) allows you to chain pipelines with triggers.
A [pipeline](https://ovh.github.io/cds/gettingstarted/concepts/pipeline/) is structured in sequential [stages](https://ovh.github.io/cds/gettingstarted/concepts/stage/) containing one or multiple concurrent [jobs](https://ovh.github.io/cds/gettingstarted/concepts/job/).
A [CDS Workflow](https://ovh.github.io/cds/docs/concepts/workflow/) allows you to chain pipelines with triggers.
A [pipeline](https://ovh.github.io/cds/docs/concepts/pipeline/) is structured in sequential [stages](https://ovh.github.io/cds/docs/concepts/stage/) containing one or multiple concurrent [jobs](https://ovh.github.io/cds/docs/concepts/job/).


### Can I use it in production?
Expand Down Expand Up @@ -112,7 +112,7 @@ All the features of the table are detailed below.

#### Pipeline

Ability to run multiple jobs simultaneously while keeping an isolation between them. [See doc about stages & jobs inside a pipeline](https://ovh.github.io/cds/gettingstarted/concepts/pipeline/). A pipeline is started with a context: 0 or 1 application, 0 or 1 environment.
Ability to run multiple jobs simultaneously while keeping an isolation between them. [See doc about stages & jobs inside a pipeline](https://ovh.github.io/cds/docs/concepts/pipeline/). A pipeline is started with a context: 0 or 1 application, 0 or 1 environment.

#### Workflow

Expand Down Expand Up @@ -178,7 +178,7 @@ Please read: https://ovh.github.io/cds/workflows/pipelines/requirements/service/

A remote cache is used by a team of developers and/or a continuous integration (CI) system to share build outputs. If your build is reproducible, the outputs from one machine can be safely reused on another machine, which can make builds significantly faster

Doc: https://ovh.github.io/cds/manual/components/worker/cache/
Doc: https://ovh.github.io/cds/docs/components/worker/cache/

#### Enterprise Notification Bus

Expand Down
2 changes: 1 addition & 1 deletion cli/README.md
@@ -1,3 +1,3 @@
# CDS - Command Line Interface

see https://ovh.github.io/cds/manual/components/cdsctl/
see https://ovh.github.io/cds/docs/components/cdsctl/
2 changes: 1 addition & 1 deletion cli/cdsctl/workflow_as_code.go
Expand Up @@ -22,7 +22,7 @@ var workflowInitCmd = cli.Command{
Short: "Init a workflow",
Long: `Initialize a workflow from your current repository, this will create yml files and push them to CDS.
Documentation: https://ovh.github.io/cds/manual/gettingstarted/init_workflow_with_cdsctl/
Documentation: https://ovh.github.io/cds/docs/tutorials/init_workflow_with_cdsctl/
`,
OptionalArgs: []cli.Arg{
Expand Down
6 changes: 3 additions & 3 deletions contrib/README.md
Expand Up @@ -13,15 +13,15 @@ See [CDS documentation](https://github.com/ovh/cds) for more details.

## Actions

See [User Actions Documentation](https://ovh.github.io/cds/manual/actions)
See [User Actions Documentation](https://ovh.github.io/cds/docs/actions)

## Worker Models

See [Worker Models Documentation](https://ovh.github.io/cds/manual/concepts/requirement/worker-model/)
See [Worker Models Documentation](https://ovh.github.io/cds/docs/concepts/requirement/worker-model/)

## Workflow Templates

See [Workflow Templates Documentation](https://ovh.github.io/cds/manual/concepts/template/)
See [Workflow Templates Documentation](https://ovh.github.io/cds/docs/concepts/template/)

## µServices

Expand Down
2 changes: 1 addition & 1 deletion contrib/actions/README.md
@@ -1,3 +1,3 @@
## How to import action

Documentation: https://ovh.github.io/cds/manual/components/cdsctl/action/import/
Documentation: https://ovh.github.io/cds/docs/components/cdsctl/action/import/
2 changes: 1 addition & 1 deletion contrib/helm/cds/README.md
Expand Up @@ -173,7 +173,7 @@ After registration on UI, keep the password displayed, we will use it in next st

The first user created on CDS is a CDS Administrator.

In order to have all that you need to run your first job you need to add a first [worker model](https://ovh.github.io/cds/manual/concepts/worker-model/). It's the perfect use case to use the [CDS Command Line](https://ovh.github.io/cds/manual/components/cdsctl/) named `cdsctl`.
In order to have all that you need to run your first job you need to add a first [worker model](https://ovh.github.io/cds/docs/concepts/worker-model/). It's the perfect use case to use the [CDS Command Line](https://ovh.github.io/cds/docs/components/cdsctl/) named `cdsctl`.

+ Dowload cdsctl

Expand Down
6 changes: 3 additions & 3 deletions contrib/helm/cds/config.toml
Expand Up @@ -222,7 +222,7 @@
# [vcs.servers.Bitbucket.bitbucket]
#
# #######
# # CDS <-> Bitbucket. Documentation on https://ovh.github.io/cds/manual/hosting/repositories-manager/bitbucket/
# # CDS <-> Bitbucket. Documentation on https://ovh.github.io/cds/hosting/repositories-manager/bitbucket/
# ########
# # You can change the consumeKey if you want
# consumerKey = "xxx"
Expand Down Expand Up @@ -256,7 +256,7 @@
[vcs.servers.Github.github]

#######
# CDS <-> Github. Documentation on https://ovh.github.io/cds/manual/hosting/repositories-manager/github/
# CDS <-> Github. Documentation on https://ovh.github.io/cds/hosting/repositories-manager/github/
########
# Github OAuth Application Client ID
clientId = "XXX"
Expand Down Expand Up @@ -295,7 +295,7 @@
# [vcs.servers.Gitlab.gitlab]
#
# #######
# # CDS <-> Gitlab. Documentation on https://ovh.github.io/cds/manual/hosting/repositories-manager/gitlab/
# # CDS <-> Gitlab. Documentation on https://ovh.github.io/cds/hosting/repositories-manager/gitlab/
# ########
# appId = "xxxx"
#
Expand Down
2 changes: 1 addition & 1 deletion contrib/worker-models/README.md
Expand Up @@ -2,7 +2,7 @@ This directory contains some examples of worker models.

# What's a worker model?

See https://ovh.github.io/cds/manual/concepts/worker-model/
See https://ovh.github.io/cds/docs/concepts/worker-model/

# How to import a worker model?

Expand Down
2 changes: 1 addition & 1 deletion contrib/workflow-templates/README.md
Expand Up @@ -2,5 +2,5 @@ This directory contains some examples of workflow templates.

# What's a workflow template?

See https://ovh.github.io/cds/manual/concepts/template/
See https://ovh.github.io/cds/docs/concepts/template/

Expand Up @@ -6,7 +6,7 @@ The Service Link prerequisite allow you to use any Docker image as a dependency

This is pretty useful if you want to make some tests with a real database, or put your builded application as a job prerequisite for doing some tests.

Doc: https://ovh.github.io/cds/manual/gettingstarted/tutorials/service-requirement-pg/
Doc: https://ovh.github.io/cds/docs/tutorials/service-requirement-pg/


# How to import it on your CDS Instance
Expand All @@ -15,7 +15,7 @@ This template is linked to group: `shared.infra`

If you want to import it, you have to be CDS Administrator on your CDS Instance.

This template uses a pre-requisite binary `apt-get`, you need a [worker model](https://ovh.github.io/cds/manual/concepts/worker-model/) with this capability on you CDS Instance.
This template uses a pre-requisite binary `apt-get`, you need a [worker model](https://ovh.github.io/cds/docs/concepts/worker-model/) with this capability on you CDS Instance.

``` bash
# import from github
Expand Down
Expand Up @@ -6,7 +6,7 @@ description: |
This is pretty useful if you want to make some tests with a real database, or put your builded application as a job prerequisite for doing some tests.
Doc: https://ovh.github.io/cds/manual/gettingstarted/tutorials/service-requirement-pg/
Doc: https://ovh.github.io/cds/docs/tutorials/service-requirement-pg/
workflow: workflow.yml
pipelines:
- 1.pipeline.yml
Expand Up @@ -9,7 +9,7 @@ The template will generates a Hello World workflow with usual steps:
- deploy on pre-production and production environments

It's the same as demo-workflow-skeleton workflow template, but does not contain dependency with a Git Repository Manager. So that, it's pretty
useful to discover CDS Workflow with the [Ready To Run](https://ovh.github.io/cds/manual/hosting/ready-to-run/docker-compose/) without having a Git
useful to discover CDS Workflow with the [Ready To Run](https://ovh.github.io/cds/hosting/ready-to-run/docker-compose/) without having a Git
repository manager attached.

# How to import it on your CDS Instance
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
@@ -1,5 +1,5 @@
#
# PLEASE READ https://ovh.github.io/cds/manual/hosting/ready-to-run/docker-compose/
# PLEASE READ https://ovh.github.io/cds/hosting/ready-to-run/docker-compose/
#

version: '3'
Expand Down
11 changes: 0 additions & 11 deletions docs/.editorconfig

This file was deleted.

2 changes: 2 additions & 0 deletions docs/.gitignore
@@ -1,2 +1,4 @@
public
.DS_Store
resources

2 changes: 1 addition & 1 deletion docs/archetypes/default.md
@@ -1,5 +1,5 @@
---
title: "{{ replace .TranslationBaseName "-" " " | title }}"
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---
Expand Down

0 comments on commit 3db8b68

Please sign in to comment.