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

Merge branch '336-standardize-documentation-section-how-to-use-it' into 'latest' 

Resolve "Standardize documentation section "How to use it""

Closes #336

See merge request r2devops/hub!183
parents c0cf45ba 1e63cd92

jobs/twig_lint/README.md

+4 −6
Original line number Diff line number Diff line
@@ -5,15 +5,13 @@ This job check if there are any errors on the twig templates 
## How to use it



1. Put your twig files in the directory "templates"

2. 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/twig_lint.yml'

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

    ```

3. 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)

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

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



## Job details

tools/job_template/job_name/README.md

+4 −7
Original line number Diff line number Diff line
@@ -5,16 +5,13 @@ 
## How to use it



1. <Your steps>

2. 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/{{ job_name }}.yml'

      - remote: 'https://jobs.r2devops.io/latest/<job_name>.yml'

    ```

3. 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)

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

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



## Job details