Skip to content

Update README.md YAML ref to denote a limitation with anchors & include

Matt Callaghan requested to merge mcallaghan-bsm/gitlab:patch-39 into master

What does this MR do?

Stumbled over this limitation during usage. Add the limitation note that anchors & include cannot be used in combination if the anchor and tag cross file boundary.

This is in reference to:

Basic investigation

Related issues

TBD (unknown) it is difficult to search/find if this is a known issue, or if we should or should not submit a report for it. (it would be NICE if it worked ... )

Author's checklist

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