Skip to content

Add troubleshooting info for 'not a known icon'

Amy Qualls requested to merge aqualls-add-better-troubleshooting-svgs into master

What does this MR do?

In gitlab-docs#1777 (closed), I'm updating the html-lint Docker image. The copy of the SVG repository in the existing Docker image did not have the SVG that a frontend engineer needed, so !147384 (merged) threw pipeline errors. She tried to self-solve the problem, but the only explanation of the problem and its solution is in https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/troubleshooting.md — not a place she would have known to look.

As part of the cleanup, let's iterate to make this process better. Let's add enough troubleshooting information about this error into the main gitlab repo to point users to the right place. Make any changes you see fit; I have no strong attachment to any of the text.

Separately, I'll also propose an improvement to the error message shown in the pipeline itself.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Amy Qualls

Merge request reports