doc: refactor documentation

Makefile

@@ -6,6 +6,7 @@ doc:
 ifndef GEN_PATH
 	$(error GEN_PATH is undefined)
 endif
+    # 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) ./

README.md

@@ -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?
@@ -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
 
@@ -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/cli/worker/cache/
+Doc: https://ovh.github.io/cds/docs/components/worker/cache/
 
 #### Enterprise Notification Bus
 

cli/README.md

@@ -1,3 +1,3 @@
 # CDS - Command Line Interface
 
-see https://ovh.github.io/cds/cli/cdsctl/
+see https://ovh.github.io/cds/docs/components/cdsctl/

cli/cdsctl/workflow_as_code.go

@@ -20,10 +20,9 @@ import (
 var workflowInitCmd = cli.Command{
 	Name:  "init",
 	Short: "Init a workflow",
-	Long: `[WARNING] THIS IS AN EXPERIMENTAL FEATURE
-Initialize a workflow from your current repository, this will create yml files and push them to CDS.
+	Long: `Initialize a workflow from your current repository, this will create yml files and push them to CDS.
 
-Documentation: https://ovh.github.io/cds/gettingstarted/firstworkflow/
+Documentation: https://ovh.github.io/cds/docs/tutorials/init_workflow_with_cdsctl/
 
 `,
 	OptionalArgs: []cli.Arg{

contrib/README.md

@@ -4,8 +4,7 @@ Here you'll find extensions ready to use with [CDS](https://github.com/ovh/cds).
 
 CDS support several kind of extensions:
 
-- Actions
-- Plugins
+- Actions & Plugins
 - worker-models
 - workflow-templates
 - µServices
@@ -14,19 +13,15 @@ See [CDS documentation](https://github.com/ovh/cds) for more details.
 
 ## Actions
 
-See [User Actions Documentation](https://ovh.github.io/cds/workflows/pipelines/actions/user/)
-
-## Plugins
-
-See [Plugins Documentation](https://ovh.github.io/cds/workflows/pipelines/actions/plugins/)
+See [User Actions Documentation](https://ovh.github.io/cds/docs/actions)
 
 ## Worker Models
 
-See [Worker Models Documentation](https://ovh.github.io/cds/workflows/pipelines/requirements/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/workflows/template/)
+See [Workflow Templates Documentation](https://ovh.github.io/cds/docs/concepts/template/)
 
 ## µServices
 

contrib/actions/README.md

@@ -1,3 +1,3 @@
 ## How to import action
 
-Documentation: https://ovh.github.io/cds/cli/cdsctl/action/import/
+Documentation: https://ovh.github.io/cds/docs/components/cdsctl/action/import/

contrib/helm/cds/README.md

@@ -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/workflows/pipelines/requirements/worker-model/). It's the perfect use case to use the [CDS Command Line](https://ovh.github.io/cds/cli/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
 

contrib/integrations/kubernetes/plugin-kubernetes/Makefile

@@ -5,9 +5,9 @@ GITHASH := $(if ${GIT_HASH},${GIT_HASH},`git log -1 --format="%H"`)
 BUILDTIME := `date "+%m/%d/%y-%H:%M:%S"`
 
 TARGET_DIR = ./dist
-TARGET_NAME = kubernetes
+TARGET_NAME = plugin-kubernetes-deployment
 
-PLUGIN_MANIFEST=`echo plugin.yml`
+PLUGIN_MANIFEST=`echo $(TARGET_NAME).yml`
 export PLUGIN_MANIFEST
 
 define PLUGIN_MANIFEST_BINARY
@@ -37,29 +37,29 @@ clean:
 	@rm -rf $(TARGET_DIR)
 
 build: $(TARGET_DIR)
-	@cp plugin.yml $(TARGET_DIR)/plugin.yml
+	@cp $(TARGET_NAME).yml $(TARGET_DIR)/$(TARGET_NAME).yml
 	@for GOOS in $(TARGET_OS); do \
 		for GOARCH in $(TARGET_ARCH); do \
 			EXTENSION=""; \
 			if test "$$GOOS" = "windows" ; then EXTENSION=".exe"; fi; \
 			echo Compiling $(TARGET_DIR)/$(TARGET_NAME)-$$GOOS-$$GOARCH$$EXTENSION $(VERSION); \
 			FILENAME=$(TARGET_NAME)-$$GOOS-$$GOARCH$$EXTENSION; \
 			GOOS=$$GOOS GOARCH=$$GOARCH $(GO_BUILD) $(TARGET_LDFLAGS) -o $(TARGET_DIR)/$$FILENAME; \
-			echo "$$PLUGIN_MANIFEST_BINARY" > $(TARGET_DIR)/plugin-$$GOOS-$$GOARCH.yml; \
-			sed -i "" "s/%os%/$$GOOS/" $(TARGET_DIR)/plugin-$$GOOS-$$GOARCH.yml; \
-			sed -i "" "s/%arch%/$$GOARCH/" $(TARGET_DIR)/plugin-$$GOOS-$$GOARCH.yml; \
-			sed -i "" "s/%filename%/$$FILENAME/" $(TARGET_DIR)/plugin-$$GOOS-$$GOARCH.yml; \
+			echo "$$PLUGIN_MANIFEST_BINARY" > $(TARGET_DIR)/$(TARGET_NAME)-$$GOOS-$$GOARCH.yml; \
+			sed -i "" "s/%os%/$$GOOS/" $(TARGET_DIR)/$(TARGET_NAME)-$$GOOS-$$GOARCH.yml; \
+			sed -i "" "s/%arch%/$$GOARCH/" $(TARGET_DIR)/$(TARGET_NAME)-$$GOOS-$$GOARCH.yml; \
+			sed -i "" "s/%filename%/$$FILENAME/" $(TARGET_DIR)/$(TARGET_NAME)-$$GOOS-$$GOARCH.yml; \
 		done; \
 	done
 
 publish:
 	@echo "Updating plugin..."
-	cdsctl admin plugins import $(TARGET_DIR)/plugin.yml
+	cdsctl admin plugins import $(TARGET_DIR)/$(TARGET_NAME).yml
 	@for GOOS in $(TARGET_OS); do \
 		for GOARCH in $(TARGET_ARCH); do \
 			EXTENSION=""; \
 			if test "$$GOOS" = "windows" ; then EXTENSION=".exe"; fi; \
 			echo "Updating plugin binary $(TARGET_NAME)-$$GOOS-$$GOARCH$$EXTENSION"; \
-			cdsctl admin plugins binary-add plugin-kubernetes-deployment $(TARGET_DIR)/plugin-$$GOOS-$$GOARCH.yml $(TARGET_DIR)/$(TARGET_NAME)-$$GOOS-$$GOARCH$$EXTENSION; \
+			cdsctl admin plugins binary-add $(TARGET_NAME) $(TARGET_DIR)/$(TARGET_NAME)-$$GOOS-$$GOARCH.yml $(TARGET_DIR)/$(TARGET_NAME)-$$GOOS-$$GOARCH$$EXTENSION; \
 		done; \
 	done

contrib/worker-models/README.md

@@ -2,7 +2,7 @@ This directory contains some examples of worker models.
 
 # What's a worker model?
 
-See https://ovh.github.io/cds/workflows/pipelines/requirements/worker-model/
+See https://ovh.github.io/cds/docs/concepts/worker-model/
 
 # How to import a worker model?
 
@@ -14,4 +14,3 @@ cdsctl worker model import ./go-official-1.11.4-stretch.yml
 cdsctl worker model import https://raw.githubusercontent.com/ovh/cds/master/contrib/worker-models/go-official-1.11.4-stretch.yml
 
 ```
-

contrib/workflow-templates/README.md

@@ -2,5 +2,5 @@ This directory contains some examples of workflow templates.
 
 # What's a workflow template?
 
-See https://ovh.github.io/cds/workflows/template/ 
+See https://ovh.github.io/cds/docs/concepts/template/
 

contrib/workflow-templates/demo-usage-service-postgresql/README.md

@@ -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/workflows/pipelines/requirements/service/example-pg/
+Doc: https://ovh.github.io/cds/docs/tutorials/service-requirement-pg/
 
 
 # How to import it on your CDS Instance
@@ -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/workflows/pipelines/requirements/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

contrib/workflow-templates/demo-usage-service-postgresql/demo-usage-service-postgresql.yml

@@ -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/workflows/pipelines/requirements/service/example-pg/
+  Doc: https://ovh.github.io/cds/docs/tutorials/service-requirement-pg/
 workflow: workflow.yml
 pipelines:
 - 1.pipeline.yml

docs/.gitignore

@@ -1,2 +1,4 @@
 public
 .DS_Store
+resources
+

docs/archetypes/default.md

@@ -1,5 +1,5 @@
 ---
-title: "{{ replace .TranslationBaseName "-" " " | title }}"
+title: "{{ replace .Name "-" " " | title }}"
 date: {{ .Date }}
 draft: true
 ---