Fix external links errors (!38507) · Merge requests · GitLab.org / GitLab

Marcin Sedlak-Jakubowski requested to merge msj-fix-external-links-0803 into master Aug 03, 2020

What does this MR do?

Fix errors from test_external_links, run on https://gitlab.com/gitlab-org/gitlab-docs/-/jobs/668261681.

Full error output

$ bundle exec nanoc check external_links
Loading site… done
Error: One or more checks failed
  Running check external_links…   error
Issues found!
  public/ee/administration/object_storage.html:
    [ ERROR ] external_links - broken reference to https://www.digitalocean.com/products/spaces: link has moved permanently to 'http://www.digitalocean.com/products/spaces/'
  public/ee/ci/ci_cd_for_external_repos/github_integration.html:
    [ ERROR ] external_links - broken reference to https://help.github.com/en/github/getting-started-with-github/access-permissions-on-github: link has moved permanently to 'https://docs.github.com/en/github/getting-started-with-github/access-permissions-on-github'
  public/ee/ci/examples/laravel_with_gitlab_and_envoy/index.html:
    [ ERROR ] external_links - broken reference to http://paislee.io/how-to-automate-docker-deployments/: 522
  public/ee/development/documentation/styleguide.html:
    [ ERROR ] external_links - broken reference to https://design.gitlab.com/content/punctuation: link has moved permanently to 'https://design.gitlab.com/content/punctuation/'
  public/ee/development/fe_guide/graphql.html:
    [ ERROR ] external_links - broken reference to https://www.apollographql.com/docs/react/api/apollo-client/: link has moved permanently to 'https://www.apollographql.com/docs/react/api/core/ApolloClient/'
  public/ee/development/fe_guide/index.html:
    [ ERROR ] external_links - broken reference to http://haml.info/: link has moved permanently to 'https://haml.info/'
  public/ee/development/feature_categorization/index.html:
    [ ERROR ] external_links - broken reference to https://about.gitlab.com/handbook/engineering/infrastructure/team/scalability: link has moved permanently to 'https://about.gitlab.com/handbook/engineering/infrastructure/team/scalability/'
  public/ee/development/integrations/jira_connect.html:
    [ ERROR ] external_links - broken reference to https://medium.com/testautomator/how-to-forward-my-local-port-to-public-using-serveo-4979f352a3bf: link has moved permanently to 'https://medium.com/automationmaster/how-to-forward-my-local-port-to-public-using-serveo-4979f352a3bf'
  public/ee/development/integrations/secure.html:
    [ ERROR ] external_links - broken reference to https://usn.ubuntu.com/: link has moved permanently to 'https://ubuntu.com/security/notices'
  public/ee/development/migration_style_guide.html:
    [ ERROR ] external_links - broken reference to https://about.gitlab.com/handbook/engineering/infrastructure/library/canary/: link has moved permanently to 'https://gitlab.com/gitlab-com/gl-infra/readiness/-/tree/master/library/canary/'
  public/ee/development/pipelines.html:
    [ ERROR ] external_links - broken reference to https://gitlab-org.gitlab.io/gitlab/webpack-report/: 404
  public/ee/development/telemetry/index.html:
    [ ERROR ] external_links - broken reference to https://about.gitlab.com/handbook/engineering/infrastructure/library/snowplow/: link has moved permanently to 'https://gitlab.com/gitlab-com/gl-infra/readiness/-/tree/master/library/snowplow/'
  public/ee/development/telemetry/snowplow.html:
    [ ERROR ] external_links - broken reference to https://about.gitlab.com/handbook/product/feature-instrumentation/: 404
  public/ee/development/what_requires_downtime.html:
    [ ERROR ] external_links - broken reference to https://about.gitlab.com/handbook/engineering/infrastructure/library/canary/: link has moved permanently to 'https://gitlab.com/gitlab-com/gl-infra/readiness/-/tree/master/library/canary/'
  public/ee/integration/recaptcha.html:
    [ ERROR ] external_links - broken reference to https://www.google.com/recaptcha/intro/index.html: link has moved permanently to 'https://www.google.com/recaptcha/about/'
  public/ee/operations/error_tracking.html:
    [ ERROR ] external_links - broken reference to https://docs.sentry.io/guides/integrate-frontend/create-new-project/: 404
    [ ERROR ] external_links - broken reference to https://docs.sentry.io/server/installation/: 404
    [ ERROR ] external_links - broken reference to https://docs.sentry.io/workflow/integrations/global-integrations/: 404
  public/ee/push_rules/push_rules.html:
    [ ERROR ] external_links - broken reference to https://regex-golang.appspot.com/assets/html/index.html: 503
  public/ee/topics/authentication/index.html:
    [ ERROR ] external_links - broken reference to https://blog.eric.van-der-vlist.com/2013/11/23/how-to-customize-gitlab-to-support-openid-authentication/: execution expired
  public/ee/user/clusters/applications.html:
    [ ERROR ] external_links - broken reference to https://about.gitlab.com/handbook/product/categories/: link has moved permanently to 'https://about.gitlab.com/handbook/product/product-categories/'
  public/ee/user/compliance/license_compliance/index.html:
    [ ERROR ] external_links - broken reference to https://yarnpkg.com/configuration/yarnrc: link has moved permanently to 'https://yarnpkg.com/configuration/yarnrc/'
    [ ERROR ] external_links - broken reference to https://crates.io: 404
  public/ee/user/group/epics/index.html:
    [ ERROR ] external_links - broken reference to https://https//gitlab.com/gitlab-org/gitlab/-/issues/214364: Failed to open TCP connection to https:443 (getaddrinfo: Name does not resolve)
  public/ee/user/group/saml_sso/index.html:
    [ ERROR ] external_links - broken reference to https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/configure-single-sign-on-non-gallery-applications: link has moved permanently to 'https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/view-applications-portal'
  public/ee/user/group/saml_sso/scim_setup.html:
    [ ERROR ] external_links - broken reference to https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/configure-single-sign-on-non-gallery-applications: link has moved permanently to 'https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/view-applications-portal'
  public/ee/user/markdown.html:
    [ ERROR ] external_links - broken reference to https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax: link has moved permanently to 'https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax'
  public/ee/user/project/deploy_boards.html:
    [ ERROR ] external_links - broken reference to https://kubernetes.io/docs/concepts/workloads/pods/pod/: link has moved permanently to 'https://kubernetes.io/docs/concepts/workloads/pods/'
  public/ee/user/project/import/clearcase.html:
    [ ERROR ] external_links - broken reference to https://www.open.collab.net/media/pdfs/ClearCase-and-the-journey-to-Git.pdf: link has moved permanently to 'https://digital.ai/resources/library'
  public/ee/user/project/import/github.html:
    [ ERROR ] external_links - broken reference to https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address: link has moved permanently to 'https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address'
  public/ee/user/project/integrations/github.html:
    [ ERROR ] external_links - broken reference to https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token: link has moved permanently to 'https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token'
  public/ee/user/project/repository/repository_mirroring.html:
    [ ERROR ] external_links - broken reference to https://help.github.com/en/github/authenticating-to-github/githubs-ssh-key-fingerprints: link has moved permanently to 'https://docs.github.com/en/github/authenticating-to-github/githubs-ssh-key-fingerprints'
    [ ERROR ] external_links - broken reference to https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token: link has moved permanently to 'https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token'
  public/runner/development/README.html:
    [ ERROR ] external_links - broken reference to https://www.parallels.com/products/desktop/download/: link has moved permanently to 'https://www.parallels.com/products/desktop/download15/'
    [ ERROR ] external_links - broken reference to https://www.virtualbox.com: link has moved permanently to 'https://www.brandbucket.com/names/virtualbox?source=ext'
  public/runner/development/index.html:
    [ ERROR ] external_links - broken reference to https://www.parallels.com/products/desktop/download/: link has moved permanently to 'https://www.parallels.com/products/desktop/download15/'
    [ ERROR ] external_links - broken reference to https://www.virtualbox.com: link has moved permanently to 'https://www.brandbucket.com/names/virtualbox?source=ext'

Author's checklist (required)

Follow the Documentation Guidelines and Style Guide.
If you have developer access or higher (for example, GitLab team members or Core Team members)
- Apply the documentation label, plus:
  - The corresponding DevOps stage and group label, if applicable.
  - development guidelines when changing docs under doc/development/*, CONTRIBUTING.md, or README.md.
  - development guidelines and Documentation guidelines when changing docs under development/documentation/*.
  - development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
- Assign the designated Technical Writer.

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:

Update the permissions table.
Link docs to and from the higher-level index page, plus other related docs where helpful.
Add GitLab's version history note(s).
Add the product tier badge.
Add/update the feature flag section.
If you're changing document headings, search doc/*, app/views/*, and ee/app/views/* for old headings replacing with the new ones to avoid broken anchors.

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.
- Ensure Technical Writing, documentation, and a docs:: scoped label are added.
- Add docs-only when the only files changed are under doc/*.
- Add twdoing when starting work on the MR.
- Add twfinished if Technical Writing team work on the MR is complete but it remains open.

3. Maintainer

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

Edited Aug 03, 2020 by Marcin Sedlak-Jakubowski

Fix external links errors

What does this MR do?

Author's checklist (required)

Review checklist

Merge request reports