Commit 803ecc72 authored by Thomas Boni's avatar Thomas Boni
Browse files

docs(all jobs): update the install step in how to use it

parent 56127230

jobs/ansible_playbook/README.md

+1 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ This job will run an [`ansible-playbook`](https://docs.ansible.com/ansible/lates 


## How to use it



1. Copy the job URL located in the `Install` part of the right panel and add it 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`.

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

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

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

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

jobs/apidoc/README.md

+1 −1
Original line number Diff line number Diff line
@@ -8,7 +8,7 @@ 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"}.

1. Copy the job URL located in the `Install` part of the right panel and add it 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`.

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

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

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

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

jobs/artisan_migrate/README.md

+1 −1
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ This job will allow you to migrate the database using a migration file that you 




1. Ensure that your project has a pre-made environment file such as `.env.testing` in example, which contains the variables that will be used by the project.

2. Copy the job URL located in the `Install` part of the right panel and add it 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`.

2. Copy/paste job URL in `include` list of your `.gitlab-ci.yml` (see the [quick setup](/use-the-hub/#quick-setup)). You can specify [a fixed version](#changelog) instead of `latest`.

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/aws_s3_sync/README.md

+1 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ This job uses the latest AWS CLI version (v2 for now) in order to sync files bet 
[AWS CLI](https://aws.amazon.com/cli/){:target="_blank"} is a unified tool to manage your AWS services. With just one tool to download and configure, you can control multiple AWS services from the command line and automate them through scripts.



## How to use it

1. Copy the job URL located in the `Install` part of the right panel and add it 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`.

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

1. Set your credentials variables in the Gitlab CI/CD variables section of your project (see the [S3 documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html){:target="_blank"} about credentials) .



    ??? summary "Need a custom Endpoint ⚓ ?"

jobs/cargo_build/README.md

+1 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ This job will compile local packages and all of their dependencies on Rust proje 
## How to use it



1. Ensure that your project have a [`cargo.toml`](https://doc.rust-lang.org/cargo/reference/manifest.html){:target="_blank"} file which contains the requirements.

1. Copy the job URL located in the `Install` part of the right panel and add it 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`.

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

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

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

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