Commit 50e49b9f authored by coconux's avatar coconux
Browse files

Docs: Add links and hovers on terms to define on the documentation

parent 6c08cb13

docs/concept.md

+3 −5
Original line number Diff line number Diff line 
# Concept



The **R2Devops hub** is a collaborative hub of CI & CD

**ready to use** jobs which helps you to easily build powerful [`pipelines`](/r2bulary#pipeline) for your

projects.

The **R2Devops hub** is a collaborative [Hub](/r2bulary/#hub) of CI & CD

**ready to use** jobs which helps you to easily build powerful Pipelines for your projects.



!!! info

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

    to support more CI/CD platforms in the future.



Each jobs of the hub can be used independently to create fully **customized pipelines.**

Each Job of the hub can be used independently to create fully **customized pipelines.**

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

customized through configuration.
@@ -18,7 +17,6 @@ customized through configuration. 
    </button>

</a>



The HTML specification is maintained by the W3C.



## Overview

docs/r2bulary.md

+0 −2
Original line number Diff line number Diff line
@@ -8,8 +8,6 @@ 
___

### Hub



The R2Devops hub is a collaborative hub of CI & CD ready to use jobs which helps you to easily build powerful pipelines for your projects.

Anyone can contribute and propose his own job and get feedback from the community.



___

### Job configuration

docs/use-the-hub.md

+6 −4
Original line number Diff line number Diff line
@@ -4,8 +4,8 @@ 


- 🦊  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

- 🔫  Be aware each file modification in your project will trigger the [Pipeline](/r2bulary/#pipeline)

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



## ⏳ Quick setup
@@ -27,7 +27,7 @@ Follows these steps to setup your CI/CD pipeline in less than 5 minutes ! 
        Check [stages](#stages) section to get more information about this list

        or if you already have a configuration with different stages.



2. Select jobs you want in [Jobs section](/jobs/) and add their URL at the end

2. Select Jobs you want in [jobs section](/jobs/) and add their URL at the end

   of your `.gitlab-ci.yml` file:



    ```yaml
@@ -41,7 +41,7 @@ Follows these steps to setup your CI/CD pipeline in less than 5 minutes ! 


        By default, the `latest` version of a job is used. You can choose to

        use a specific version using a `tag`. Available tags are described for

        each job in [Jobs section](/jobs/). Description of `tag` format is

        each job in [jobs section](/jobs/). Description of `tag` format is

        available in [Versioning page](/versioning/).



        Once your pipeline is functional, we recommend to use a specific version
@@ -140,3 +140,5 @@ trivy_image: 
    In this way, you can override all Gitlab jobs parameters. All parameters

    are described in [Gitlab

    documentation](https://docs.gitlab.com/ee/ci/yaml/){:target="_blank"}.



--8<-- "includes/abbreviations.md"

docs/versioning.md

+4 −3
Original line number Diff line number Diff line 
# Versioning



Each job of the hub are versioned using a git tag.

Each Job of the Hub are versioned using a git tag.



!!! note

    Version follows the [Semantic Versioning](https://semver.org/){:target="_blank"}.
@@ -20,5 +20,6 @@ include: 
  - remote: 'https://jobs.r2devops.io/0.1.0/apidoc.yml'

```



Available tags and release note for each job are available in [Jobs

section](/jobs/).
 
Available tags and release note for each job are available in [jobs section](/jobs/).



--8<-- "includes/abbreviations.md"

includes/abbreviations.md

+21 −2
Original line number Diff line number Diff line 
*[HTML]: Hyper Text Markup Language

*[W3C]: World Wide Web Consortium
 
*[Pipelines]:

Set of jobs launched in the same sequence. Pipeline can be run manually, after a commit or a merge into a branch. We consider the pipeline as succeeded if all jobs in the pipeline success.



*[Pipeline]:

Set of jobs launched in the same sequence. Pipeline can be run manually, after a commit or a merge into a branch. We consider the pipeline as succeeded if all jobs in the pipeline success.





*[Job]:

A job is a program hosted in R2Devops Hub that can be included in CI/CD pipeline to do a unitary work.





*[Jobs]:

A job is a program hosted in R2Devops Hub that can be included in CI/CD pipeline to do a unitary work.





*[CI]:



*[CD]:



*[Hub]:

The R2Devops hub is a collaborative hub of CI & CD ready to use jobs which helps you to easily build powerful pipelines for your projects. Anyone can contribute and propose his own job and get feedback from the community.