Skip to content

Make clearer that the link points to instructions

Amy Qualls requested to merge 226001-docs-aqualls-tool-link into master

What does this MR do?

Attempts to address that the lint link in https://docs.gitlab.com/ee/user/project/pages/getting_started/pages_from_scratch.html#specify-the-public-directory-for-artifacts points to a page describing how to use a tool, (https://docs.gitlab.com/ee/ci/yaml/README.html#validate-the-gitlab-ciyml) rather than the tool itself.

The original MR implied the link itself was broken, but that's not the case. The link is an internal link, which means it's checked on every pipeline; broken internal links result in a failed docs-lint job and a failed pipeline.

Related issues

Closes #226001 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

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

  • 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 Jackie Porter

Merge request reports

Loading