Commit c6eda453 authored by Thomas Boni's avatar Thomas Boni
Browse files

Merge branch '35-update-documentation-after-brainstorming' into 'latest' 

Resolve "Update Documentation after brainstorming"

Closes #35

See merge request go2scale/hub!15
parents c134b09c 537f1d62

README.md

+3 −2
Original line number Diff line number Diff line
@@ -2,10 +2,11 @@ 


## Description



**Go2Scale hub** is a collaborative hub of CI & CD ready to use jobs which

**Go2Scale hub** is a collaborative hub of CI & CD **ready to use** jobs which

helps you to quickly build powerful pipelines for your projects.



Each jobs of the hub can be used unitary or to create fully customs pipelines.



Each jobs of the hub can be used unitary or to create fully **customs pipelines.**

You can use them for any kind of software and deployment type. Each job can be

customized through configuration.

docs/css/extra.css

0 → 100644
+25 −0
Original line number Diff line number Diff line 
.center {

    display: block;

    margin: 0 auto;

}



.right {

    float: right;

}



.left {

    float: left;

}



.red{

  color:red;

}



.small_gitlab{

  width:20%

}





table{

  max-height: 500px;

}

docs/getting-started.md

+9 −3
Original line number Diff line number Diff line 
# Getting started



## 📝 Prerequisites



- 🦊  Manage your project in Gitlab

- ✏️   Have the write access to the `.gitlab-ci.yml` file in your project

- 🔫  Be aware each file modification in your project will trigger the pipeline

- 🗝  Have access to the Pipelines page in your Gitlab project to see the pipeline execution



## ⏳ Quick setup



Follows these steps to setup your CI/CD pipeline in less than 10 minutes !
@@ -59,7 +66,7 @@ An example of a full `.gitlab-ci.yml` file with: 
* One job template with latest version. Note that `latest/` is optional in the

  job URL

* One job template with specific version using tag `2020-08-05_1`

* A custom `unit_tests` job

* Your own local `unit_tests` job



``` yaml

stages:
@@ -74,12 +81,11 @@ include: 
  - remote: 'https://jobs.go2scale.io/latest/docker.yml'

  - remote: 'https://jobs.go2scale.io/2020-08-05_1/mkdocs.yml'



# You can also include your own jobs

# You can also include your own local jobs

unit_tests:

  image: python:3.7-alpine3.10

  stage: static_tests

  before_script:

    - apk add gcc make musl-dev postgresql-dev git linux-headers libmagic jpeg-dev zlib-dev

    - pip install pipenv && pipenv --bare install --dev

  script:

    - make test

docs/index.md

+2 −2
Original line number Diff line number Diff line
@@ -3,14 +3,14 @@ 
Welcome to the Go2Scale hub ! 🎉



**Go2Scale hub** is a collaborative hub of CI & CD

ready to use jobs which helps you to quickly build powerful pipelines for your

**ready to use** jobs which helps you to quickly build powerful pipelines for your

projects.



!!! info

    Currently, the hub is focused to provides only **Gitlab 🦊** jobs. We plan

    to support more CI/CD platforms in the future.



Each jobs of the hub can be used unitary to create fully customs pipelines.

Each jobs of the hub can be used unitary to create fully **customs pipelines.**

You can use them for any kind of software and deployment type. Each job can be

customized through configuration.

docs/jobs/build/apidoc.md

+1 −1
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ code using [apiDoc](https://www.apidocjs.com/). 


| Name | Description | Default |

| ---- | ----------- | ------- |

| `APIDOC_VERSION` | Version of apiDoc to use | `0.24.0` |

| `APIDOC_VERSION` <img width=250/> | Version of apiDoc to use <img width=400/> | `0.24.0` |

| `APIDOC_CONFIG_PATH` | Path to config file or to directory containing config file (apidoc.json or apidoc.config.js) | `.` |

| `APIDOC_OUTPUT_PATH` | Output directory path | `/documentation_build` |

| `APIDOC_TEMPLATE_PATH` | Path to template folder | `/usr/lib/node_modules/apidoc/template/` |