Skip to content

Trim internal-links-and-anchors-check outout to the essentials

Katrin Leinweber (GTLB) requested to merge 1723-trim-internal-links-and-anchors-check-output into main

What does this MR do and why?

Closes #1723.

An implementation of idea 1. there ☝ plus a compression of the output list by 50% of the bulletted lines. If this were run against the same commit as this, the resulting output should be:

$ parallel time bundle exec nanoc check ::: internal_links internal_anchors
  Running check internal_links…   error
Issues found!
  public/ee/user/profile/account/delete_account.html:
    [ ERROR ] internal_links - broken reference to file:///tmp/gitlab-docs/public/ee/project/repository/index.html
Loading site… done
Error: One or more checks failed
  Running check internal_anchors…   error
Issues found!
  (global):
    [ ERROR ] internal_anchors - Broken anchor detected: #commit-changes-to-a-repository
      - source file `/tmp/gitlab-docs/public/ee/user/profile/account/delete_account.html`
      - destination `../../../project/repository/index.html`

Loading site… done
Error: One or more checks failed
Cleaning up project directory and file based variables
ERROR: Job failed: exit code 1

While "Failed jobs" tab shows incomplete stacktraces (gitlab#423443) remains open, this would mean at least 1 full block of [ ERROR ] internal_anchors - Broken anchor detected! would be visible in the Failed Jobs preview.

Screenshots, screen recordings, or links to review app

See codeblock above.

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/setup.md.

Merge request acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Katrin Leinweber (GTLB)

Merge request reports