diff --git a/documentation/ci_faq.md b/documentation/ci_faq.md index d083d62ef37cb6e7d9653eebd21aa1d9387e3bfb..a4112108bead2c9582d26b14d3c4fdb3eb74274d 100644 --- a/documentation/ci_faq.md +++ b/documentation/ci_faq.md @@ -36,10 +36,10 @@ directory. ## How does CI work? When a commit is added to a branch in our repository, a notification is sent out to our gitlab-ci-runner, which instructs it to checkout the updated branch and -run the directive in `.gitlab-ci.yml`. It then runs each directive, which is +run the directive in [`.gitlab-ci.yml`](.gitlab-ci.yml). It then runs each directive, which is made up of bash scripts to execute. In our case, we run two scripts, -`ci-build.sh` and `ci-test.sh`, which compile projects and run checks, -respectively. (Look at these scripts to learn more about how they work). If -some error occurs during the script (perhaps a forced error generated by a -failed test), then the runner sends a message back to Gitlab indicating that the -CI failed. Otherwise, it succeeds. +[`ci-build.sh`](ci/ci-build.sh) and [`ci-test.sh`](ci/ci-test.sh), +which compile projects and run checks, respectively. Look at these scripts to +learn more about how they work. If some error occurs during the script +(perhaps a forced error generated by a failed test), then the runner sends a +message back to Gitlab indicating that the CI failed. Otherwise, it succeeds.