Commit 431552a4 authored by Thomas Boni's avatar Thomas Boni
Browse files

add how to update doc section in readme

parent 3a6af745
Loading
Loading
Loading
Loading
+36 −16
Original line number Diff line number Diff line
# Go2Scale DevSecOps templates

Go2Scale DevSecOps CI & CD jobs & pipelines templates repository
# g2s hub

## Description

[Jobs repository](https://gitlab.com/go2scale/jobs) contains all Go2Scale
DevSecOps CI & CD jobs & pipelines templates. This documentation goal is to
explain how to use them efficiently and easilly in your projects.
**g2s 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.
You can use them for any kind of software and deployment type. Each job can be
customized through configuration.

Check the [documentation](https://go2scale.gitlab.io/jobs/).

## How to work on the documentation

### Requirements

Documentation is built using [Mkdocs](https://www.mkdocs.org) and [Material for
Mkdocs](https://squidfunk.github.io/mkdocs-material/).

Make sure that `python` and `pip` are installed on your system. Then install
all required components:

```shell
pip install mkdocs-material mkdocs-minify-plugin mkdocs-git-revision-date-localized-plugin mkdocs-awesome-pages-plugin pymdown-extensions
```

We offer 2 levels of modules:
### Clone the repository

**Pipeline** templates: multiple jobs assembled in a workflow
Clone the repository locally

* Easy to use, just import the template in your CI configuration
* Must be consitent with your software and deployment type
* Customizable through configuration
```shell
git clone git@gitlab.com:go2scale/jobs.git
cd jobs
```

**Jobs** templates: only one jobs
### Launch Mkdocs

* Can be used unitary or to create fully customs pipelines
* Adaptable to any kind of software and deployment type
* Customizable through configuration
You can launch mkdocs in order to create a local web server with hot reload to
see your updates in live

**Documentation:** https://go2scale.gitlab.io/jobs
```shell
mkdocs serve
```