Commit 111ec291 authored by coco's avatar coco
Browse files

Updating documentation

parent c134b09c

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

+7 −0
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 !

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/dynamic_tests/trivy_image.md

+4 −2
Original line number Diff line number Diff line
@@ -40,9 +40,10 @@ vulnerability detection capabilities are available in its official 


### Variables





| VARIABLE NAME | DESCRIPTION | DEFAULT VALUE |

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

| `IMAGE` | Target name or target path | `$CI_REGISTRY_IMAGE:$CI_COMMIT_SHA` or `$CI_REGISTRY_IMAGE:$CI_COMMIT_TAG` in case of tag creation |

|:-|:-|:-

| `IMAGE` <img width=450/> | Target name or target path <img width=500/> | `$CI_REGISTRY_IMAGE:$CI_COMMIT_SHA` <br/> or `$CI_REGISTRY_IMAGE:$CI_COMMIT_TAG` in case of tag creation |

| `TRIVY_VERSION` | Version of trivy to use. Releases version are available [here](https://github.com/aquasecurity/trivy/releases) | `0.9.2` |

| `TRIVY_SEVERITY` | Severities of vulnerabilities to be displayed | `UNKNOWN`,`LOW`,`MEDIUM`,`HIGH`,`CRITICAL`|

| `TRIVY_EXIT_CODE` | Exit code when vulnerabilities were found | 1 |
@@ -64,6 +65,7 @@ vulnerability detection capabilities are available in its official 
| `TRIVY_SKIP_UPDATE` | Skip vulnerability database update | false |

| `TRIVY_REMOVED_PKGS` | Detect vulns of Alpine removed packages | false |





### Artifacts



We use [Junit](https://junit.org/junit5/)'s XML report to display error report