diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2023-06-07 19:05:19 +0300 |
|---|---|---|
| committer | Marcel Amirault <mamirault@gitlab.com> | 2023-06-07 19:05:19 +0300 |
| commit | 8db3250bea688d4c23405bbd3181ef1b0522ef85 (patch) | |
| tree | ced83c294f58a1ee46463bbdb90391b044af85ec /doc | |
| parent | bf1920d723cbbcf40867bf13995b1f881ca58b5f (diff) | |
Add issue template to update the html-lint image
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/architecture.md | 12 | ||||
| -rw-r--r-- | doc/troubleshooting.md | 18 |
2 files changed, 24 insertions, 6 deletions
diff --git a/doc/architecture.md b/doc/architecture.md index b04e670b..25a445b0 100644 --- a/doc/architecture.md +++ b/doc/architecture.md @@ -110,11 +110,10 @@ improve maintainability: ### Rebuild the docs site Docker images -Once a week on Mondays, a scheduled pipeline runs and rebuilds the Docker images -used in various pipeline jobs, like `docs-lint`. The Docker image configuration files are +The Docker image configuration files are located in the [Dockerfiles directory](https://gitlab.com/gitlab-org/gitlab-docs/-/tree/main/dockerfiles). -If you need to rebuild the Docker images immediately (must have maintainer level permissions): +If you need to rebuild one or all the Docker images (must have at least the Maintainer role on the project): WARNING: If you change the Dockerfile configuration and rebuild the images, you can break the main @@ -123,11 +122,12 @@ a different name first and test it to ensure you do not break the pipelines. 1. In [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs), go to **{rocket}** **CI/CD > Pipelines**. 1. Select **Run pipeline**. -1. See that a new pipeline is running. The jobs that build the images are in the first +1. See that a new pipeline is running. The jobs that build the images are in the second stage, `build-images`. You can select the pipeline number to see the larger pipeline - graph, or select the first (`build-images`) stage in the mini pipeline graph to + graph, or select the second (`build-images`) stage in the mini pipeline graph to expose the jobs that build the images. -1. Select the **play** (**{play}**) button next to the images you want to rebuild. +1. After the test builds have passed, select the **play** (**{play}**) button + next to the images you want to rebuild. ### Deploy the docs site diff --git a/doc/troubleshooting.md b/doc/troubleshooting.md index 215a3824..81b77486 100644 --- a/doc/troubleshooting.md +++ b/doc/troubleshooting.md @@ -55,3 +55,21 @@ There are a few ways to tell whether a pipeline is from an upstream project: - The **test** stage contains only two jobs: `test_global_nav_links` and `untamper-my-lockfile`. - The **deploy** stage contains the `review` job. + +## Error: `ArgumentError: <icon name> is not a known icon in @gitlab-org/gitlab-svg` + +When a new icon is added to the [`gitlab-svgs` library](https://gitlab.com/gitlab-org/gitlab-svgs) +and we use it immediately in the documentation, the `docs-lint links` job +in the upstream projects fails with an error like: + +```plaintext +ArgumentError: <icon name> is not a known icon in @gitlab-org/gitlab-svg +``` + +This error happens when the `lint-html` image has an older version of `@gitlab/svgs` +which doesn't include the new icon. + +To solve this, follow the template to build a +[new `lint-html` image](https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=html-lint-image-new-version&issue[title]=Upgrade%20the%20lint-html%20Docker%20image). + +For more information, see issue [1639](https://gitlab.com/gitlab-org/gitlab-docs/-/issues/1639). |