Commit d86ed209 authored by Thibaud-Vdb's avatar Thibaud-Vdb
Browse files

chore(jobs): fix all broken documentation links

parent dd561245

.gitlab-ci.yml

+1 −1
Original line number Diff line number Diff line
@@ -218,7 +218,7 @@ links_checker: 
  variables:

    # The following hard excluded link is due that this

    # job will be migrated to a new tool soon (see #314)

    LICHE_EXCLUDE: ^([^http]|https://gitlab.com/r2devops/hub/-/forks/new)|^([^http]|https://r2devops.io/.+)|^([^http]|https://api.r2devops.io/.+)

    LICHE_EXCLUDE: ^([^http]|https://gitlab.com/r2devops/hub/-/forks/new)|^([^http]|https://r2devops.io/.+)|^([^http]|https://api.r2devops.io/.+)|^([^http]|https://en.wikipedia.org/wiki/Dry_run_\(testing)

    FAIL_ON_BROKEN: "true"

    LICHE_DIRECTORY: "jobs/"

  allow_failure: true

.gitlab/merge_request_templates/Default.md

+4 −4
Original line number Diff line number Diff line
@@ -10,21 +10,21 @@ 
* [ ] Ensure that the jobs is working

* [ ] Create a new change-log file (initial version must be `0.1.0`)

* [ ] Update the documentation (`README.md` file)

* [ ] Check if your job follows our [guidelines](https://docs.r2devops.io/contribute/#guidelines-required) and [best practices](https://docs.r2devops.io/contribute/#best-practices-optional)

* [ ] Check if your job follows our [guidelines](https://docs.r2devops.io/public-catalog/contribute/#guidelines-required) and [best practices](https://docs.r2devops.io/public-catalog/contribute/#best-practices-optional)

* [ ] Ensure pipeline doesn't fail

* [ ] Update the dictionary if the job `spell_check` fails, and it's not a typo  



### Field: Update the documentation



* [ ] Check the documentation result is rendered properly in pipeline `MkDocs` artifact

* [ ] Check if your job follows our [guidelines](https://docs.r2devops.io/contribute/#guidelines-required) and [best practices](https://docs.r2devops.io/contribute/#best-practices-optional)

* [ ] Check if your job follows our [guidelines](https://docs.r2devops.io/public-catalog/contribute/#guidelines-required) and [best practices](https://docs.r2devops.io/public-catalog/contribute/#best-practices-optional)

* [ ] Ensure pipeline doesn't fail

* [ ] Update the dictionary if the job `spell_check` fails, and it's not a typo  

* [ ] Fix the broken links if any is prompted by the `links_checker` job



### Field: Update one of the hub tools



* [ ] Check if your job follows our [guidelines](https://docs.r2devops.io/contribute/#guidelines-required) and [best practices](https://docs.r2devops.io/contribute/#best-practices-optional)

* [ ] Check if your job follows our [guidelines](https://docs.r2devops.io/public-catalog/contribute/#guidelines-required) and [best practices](https://docs.r2devops.io/public-catalog/contribute/#best-practices-optional)

* [ ] Ensure the tool is working properly locally 

* [ ] Ensure the tool is working properly in the pipeline 

* [ ] If needed, update `Pipfile` (and `Pipfile.lock`) dedicated to the tool
@@ -35,7 +35,7 @@ 


### Field: Update hub's pipeline 



* [ ] Check if it follows our [guidelines](https://docs.r2devops.io/contribute/#guidelines-required) and [best practices](https://docs.r2devops.io/contribute/#best-practices-optional)

* [ ] Check if it follows our [guidelines](https://docs.r2devops.io/public-catalog/contribute/#guidelines-required) and [best practices](https://docs.r2devops.io/public-catalog/contribute/#best-practices-optional)

* [ ] Check if the new pipeline is working properly in a fork



## When I'm done

jobs/ansible_playbook/CHANGELOG.md

+3 −0
Original line number Diff line number Diff line 
# Changelog

All notable changes to this job will be documented in this file.



## [0.2.1] - 2023-02-28

* Fix broken documentation links



## [0.2.0] - 2022-06-13

* Add docker image tag in variable

jobs/ansible_playbook/README.md

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


## How to use it



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. Copy/paste job URL in `include` list of your `.gitlab-ci.yml` (see the [quick use](https://docs.r2devops.io/get-started/use-templates/#use-a-template)). You can specify [a fixed version](https://docs.r2devops.io/get-started/use-templates/#versioning) instead of `latest`.

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

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

   customization](https://docs.r2devops.io/get-started/use-templates/#job-templates-customization)

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



## Variables

jobs/apidoc/CHANGELOG.md

+3 −0
Original line number Diff line number Diff line 
# Changelog

All notable changes to this job will be documented in this file.



## [0.4.3] - 2023-02-28

* Fix broken documentation links



## [0.4.2] - 2022-06-13

* Add docker image tag in variable