Commit 21383ebe authored by Thomas Boni's avatar Thomas Boni
Browse files

Merge branch '551-update-how-to-use-it-section' into 'latest' 

Resolve "Update "How to use it" section"

Closes #551

See merge request r2devops/hub!338
parents 4ef632ff fbbfba6c

jobs/ansible_playbook/README.md

+9 −12
Original line number Diff line number Diff line
@@ -4,13 +4,10 @@ This job will run an [`ansible-playbook`](https://docs.ansible.com/ansible/lates 


## How to use it



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

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

    ```

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

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`. 

2. 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 ! 😀

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



## Job details
@@ -23,7 +20,7 @@ This job will run an [`ansible-playbook`](https://docs.ansible.com/ansible/lates 
### Variables



| Name                                      | Description                                                                                                                                       | Default              |

| ---- | ----------- | ------- |

| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |

| `ANSIBLE_WORKSPACE` <img width=100/>      | The path where is located your ansible project <img width=175/>                                                                                   | `.` <img width=100/> |

| `ANSIBLE_INVENTORY_FILE` <img width=100/> | The inventory file where are described roles and groups. This variable should be specified in `Gitalb > CI/CD Settings` as file. <img width=175/> | ` ` <img width=100/>  |

| `SSH_PRIVATE_KEY_FILE` <img width=100/>   | ⚠️ Mandatory variable. The name of your private SSH key. his variable should be specified in `Gitalb > CI/CD Settings` as file. <img width=175/>   | ` ` <img width=100/>  |

jobs/apidoc/README.md

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

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

    ```

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. 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 −4
Original line number Diff line number Diff line
@@ -9,10 +9,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. 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

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

    ```

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`.

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 −4
Original line number Diff line number Diff line
@@ -5,10 +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. 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

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

    ```

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. 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 −4
Original line number Diff line number Diff line
@@ -5,10 +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. 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

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

    ```

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. 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 ! 😀