Skip to content

Add HTML comment explaining 503 issue

Amy Qualls requested to merge 2980982-aqualls-fix-links into master

What does this MR do?

These links were identified as problematic in the December 2020 link check:

  public/ee/administration/git_protocol.html:
    [ ERROR ] external_links - broken reference to https://dashboards.gitlab.com/d/pqlQq0xik/git-protocol-versions: 503

  public/ee/administration/integration/terminal.html:
    [ ERROR ] external_links - broken reference to https://varnish-cache.org/docs/4.1/users-guide/vcl-example-websockets.html: 404

The first one is a link to a GitLab resource behind an auth wall. We can either put it in inline code tags or we can put a HTML comment in place. I chose the latter but can be convinced otherwise.

Second one is a valid link. Probably an intermittent failure.

Related issues

Closes #290982 (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.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

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.

Merge request reports