Commit 1320cdff authored by Thomas Boni's avatar Thomas Boni
Browse files

update how to use job section in all jobs

parent e5a77d81

jobs/apidoc/README.md

+4 −8
Original line number Diff line number Diff line
@@ -8,17 +8,13 @@ code using [apiDoc](https://apidocjs.com/){:target="_blank"}. 
1. Prepare your project with API annotations in your source code following

   [apiDoc format](https://apidocjs.com/#examples){:target="_blank"} and your [apiDoc

   configuration file](https://apidocjs.com/#configuration){:target="_blank"}.

2. Choose a version in [version list](#changelog)

3. Add the corresponding URL to your `.gitlab-ci.yml` file (see [Getting started](/use-the-hub/)). Example:



1. Add this job URL inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)). You can specify [a fixed version](#changelog) instead of `latest`.

    ```yaml

    include:

      - remote: 'https://jobs.r2devops.io/apidoc.yml'

      - remote: 'https://jobs.r2devops.io/latest/apidoc.yml'

    ```



4. If you need to customize the job (stage, variables, ...) 👉 check the [jobs

1. If you need to customize the job (stage, variables, ...) 👉 check the [jobs

   customization](/use-the-hub/#jobs-customization)

5. Well done, your job is ready to work ! 😀

1. Well done, your job is ready to work ! 😀



## Job details

jobs/docker_build/README.md

+2 −4
Original line number Diff line number Diff line
@@ -14,11 +14,9 @@ remote registry. The build part is done using 
1. Create a

   [Dockerfile](https://docs.docker.com/get-started/part2/#sample-dockerfile){:target="_blank"} (by default at the root of your project)

   to containerize your application

2. Choose a version in [version list](#changelog)

1. Add this job URL inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)):

1. Add this job URL inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)). You can specify [a fixed version](#changelog) instead of `latest`.

    ```yaml

    include:

      - remote: 'https://jobs.r2devops.io/docker_build.yml'

      - remote: 'https://jobs.r2devops.io/latest/docker_build.yml'

    ```

4. If you need to customize the job (stage, variables, ...) 👉 check the [jobs

   customization](/use-the-hub/#jobs-customization)

jobs/dotnet_build/README.md

+2 −5
Original line number Diff line number Diff line
@@ -6,13 +6,10 @@ It is using the scripted installation provided from Microsoft, see [here](https: 
## How to use it



1. Prepare your project in your repository with its `.csproj` file.

1. Add this job URL inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)):



1. Add this job URL inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)). You can specify [a fixed version](#changelog) instead of `latest`.

    ```yaml

    include:

      - remote: 'https://jobs.r2devops.io/dotnet_build.yml'

      - remote: 'https://jobs.r2devops.io/latest/dotnet_build.yml'

    ```



3. If you need to customize the job (stage, variables, ...) 👉 check the [jobs

   customization](/use-the-hub/#jobs-customization)

jobs/doxygen/README.md

+2 −5
Original line number Diff line number Diff line
@@ -9,13 +9,10 @@ Other languages can be supported with additional code. 




1. Ensure that your source code is documenting using [Doxygen syntax](https://www.doxygen.nl/manual/docblocks.html){:target="_blank"}

1. Add this job URL inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)):



1. Add this job URL inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)). You can specify [a fixed version](#changelog) instead of `latest`.

    ```yaml

    include:

      - remote: 'https://jobs.r2devops.io/doxygen.yml'

      - remote: 'https://jobs.r2devops.io/latest/doxygen.yml'

    ```



3. If you need to customize the job (stage, variables, ...) 👉 check the [jobs

   customization](/use-the-hub/#jobs-customization)

4. Well done, your job is ready to work ! 😀

jobs/gitleaks/README.md

+2 −4
Original line number Diff line number Diff line
@@ -8,11 +8,9 @@ repos. As it written in go, it is much faster than most of the 
## How to use it





1. Add the corresponding URL to your `.gitlab-ci.yml` file (see [Getting started](/use-the-hub/)). Example:



1. Add this job URL inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)). You can specify [a fixed version](#changelog) instead of `latest`.

    ```yaml

    include:

      - remote: 'https://jobs.r2devops.io/gitleaks.yml'

      - remote: 'https://jobs.r2devops.io/latest/gitleaks.yml'

    ```

2. Well done, your job is ready to work ! 😀