Skip to content

Docs: Add tip for symbolic links as CI include

Michael Friedrich requested to merge docs/ci-include-symlinks into master

What does this MR do?

For the Contribute Challenge 2020 I want to help improve the documentation regarding the CI keywords.

Today I was preparing my GitLab meetup demo, and struggled from creating a symlink for the .gitlab-ci.yml file. I've then found an issue comment suggesting to use include.

This MR follows !30206 (merged) and adds the symbolic link tip into the include: local chapter. This helps with documenting the workaround in #17090 :)

Related issues

#17090 (comment 214945841)

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports