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

docs(all jobs): remove useless doc in jobs

parent fd0fc26d

jobs/ansible_playbook/README.md

+2 −10
Original line number Diff line number Diff line
@@ -10,15 +10,7 @@ This job will run an [`ansible-playbook`](https://docs.ansible.com/ansible/lates 
   customization](/use-the-hub/#jobs-customization)

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



## Job details



* Job name: `ansible_playbook`

* Docker image:

[`alpine:3.15.1`](https://hub.docker.com/r/_/alpine)

* Default stage: `deploy`

* When: `always`



### Variables

## Variables



| Name                                      | Description                                                                                                                                       | Default              |

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

jobs/apidoc/README.md

+4 −12
Original line number Diff line number Diff line
@@ -13,15 +13,7 @@ code using [apiDoc](https://apidocjs.com/){:target="_blank"}. 
   customization](/use-the-hub/#jobs-customization)

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



## Job details



* Job name: `apidoc`

* Docker image:

[`node:18.1-alpine3.14`](https://hub.docker.com/r/_/node){:target="_blank"}

* Default stage: `build`

* When: `always`



### Variables

## Variables



| Name | Description | Default |

| ---- | ----------- | ------- |
@@ -35,7 +27,7 @@ code using [apiDoc](https://apidocjs.com/){:target="_blank"}. 
| `APIDOC_OPTIONS` | Additional options | ` ` |

| `IMAGE_TAG` | The default tag for the docker image | `18.1-alpine3.14`  |



### Artifacts

## Artifacts



When the job is successful, the build of your documentation is available as artifact.
@@ -50,5 +42,5 @@ When the job is successful, the build of your documentation is available as arti 






### Author

## Author

This resource is an **[official job](https://docs.r2devops.io/faq-labels/)** added in [**R2Devops repository**](https://gitlab.com/r2devops/hub) by [@thomasboni](https://gitlab.com/thomasboni)

jobs/artisan_migrate/README.md

+7 −15
Original line number Diff line number Diff line
@@ -16,15 +16,7 @@ This job will allow you to migrate the database using a migration file that you 
4. Well done, your job is ready to work ! 😀





## Job details



* Job name: `artisan_migrate`

* Default stage: `deploy`

* Docker image: [`edbizarro/gitlab-ci-pipeline-php:7.3`](https://hub.docker.com/r/edbizarro/gitlab-ci-pipeline-php){:target="_blank"}

* When: `manual`, only when running on default branch (`$CI_DEFAULT_BRANCH`).

  To update this behavior, see [job customization](https://r2devops.io/use-the-hub/#global) to override [`rules`](https://docs.gitlab.com/ee/ci/yaml/#rulesif)



### Variables

## Variables



!!! info

    If you have setup Gitlab's CI/CD variables, they will be used instead of the ones defined in `.env`, just make sure to name them exactly the same.
@@ -37,7 +29,7 @@ This job will allow you to migrate the database using a migration file that you 
| `ARTISAN_OUTPUT` | `artisan_migration.log` | Name for logs file |





### Artifacts

## Artifacts



When the job is done, the command's output will be available under the file name `ARTISAN_OUTPUT` as an artifact.
@@ -52,5 +44,5 @@ When the job is done, the command's output will be available under the file name 
    with any output location.





### Author

## Author

This resource is an **[official job](https://docs.r2devops.io/faq-labels/)** added in [**R2Devops repository**](https://gitlab.com/r2devops/hub) by [@moha-s](https://gitlab.com/moha-s)

jobs/aws_s3_sync/README.md

+2 −7
Original line number Diff line number Diff line
@@ -16,12 +16,7 @@ This job uses the latest AWS CLI version (v2 for now) in order to sync files bet 
   customization](/use-the-hub/#jobs-customization)

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



## Job details

* Job name: `aws_s3_sync`

* Docker image: [alpine:3.13.6](https://hub.docker.com/_/alpinei){:target="_blank"}

* Default stage: `deploy`



### Variables

## Variables



| Name | Description | Default |

| ---- | ----------- | ------- |
@@ -37,5 +32,5 @@ This job uses the latest AWS CLI version (v2 for now) in order to sync files bet 






### Author

## Author

This resource is an **[official job](https://docs.r2devops.io/faq-labels/)** added in [**R2Devops repository**](https://gitlab.com/r2devops/hub) by [@GridexX](https://gitlab.com/GridexX)

jobs/cargo_build/README.md

+6 −14
Original line number Diff line number Diff line
@@ -10,15 +10,7 @@ This job will compile local packages and all of their dependencies on Rust proje 
   customization](/use-the-hub/#jobs-customization)

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



## Job details



* Job name: `cargo_build`

* Docker image:

[`rust:1.57-buster`](https://hub.docker.com/r/_/rust)

* Default stage: `build`

* When: `always`



### Variables

## Variables



!!! note

    All paths defined in variables are relative and start from the root of your
@@ -37,5 +29,5 @@ This job will compile local packages and all of their dependencies on Rust proje 






### Author

## Author

This resource is an **[official job](https://docs.r2devops.io/faq-labels/)** added in [**R2Devops repository**](https://gitlab.com/r2devops/hub) by [@alexiaognard](https://gitlab.com/alexiaognard)