Commit 3cedfa26 authored by Sascha Eggenberger's avatar Sascha Eggenberger 💬 Committed by Lee Tickett
Browse files

Replaces non-rendered icon references (dotted-circle & check-circle) with shortcodes

parent 8f9bc8c7

content/handbook/engineering/architecture/design-documents/container_registry_metadata_database/_index.md

+22 −22
Changes for content/handbook/engineering/architecture/design-documents/container_registry_metadata_database/_index.md: 22 added lines, 22 removed lines.
Original line number Diff line number Diff line
@@ -82,12 +82,12 @@ The single entrypoint for the registry is the [HTTP API](https://gitlab.com/gitl 


| Operation                                                    | UI                 | Background               | Observations                                                 |

| ------------------------------------------------------------ | ------------------ | ------------------------ | ------------------------------------------------------------ |

| [Check API version](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#api-version-check) | **{check-circle}** Yes | **{check-circle}** Yes | Used globally to ensure that the registry supports the Docker Distribution V2 API, as well as for identifying whether GitLab Rails is talking to the GitLab container registry or a third-party one (used to toggle features only available in the former). |

| [List repository tags](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#listing-image-tags) | **{check-circle}** Yes | **{check-circle}** Yes | Used to list and show tags in the UI. Used to list tags in the background for [cleanup policies](../../../user/packages/container_registry/reduce_container_registry_storage.md#cleanup-policy) and [Geo replication](../../../administration/geo/replication/container_registry.md). |

| [Check if manifest exists](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#existing-manifests) | **{check-circle}** Yes | **{dotted-circle}** No | Used to get the digest of a manifest by tag. This is then used to pull the manifest and show the tag details in the UI. |

| [Pull manifest](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#pulling-an-image-manifest) | **{check-circle}** Yes | **{dotted-circle}** No | Used to show the image size and the manifest digest in the tag details UI. |

| [Pull blob](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#pulling-a-layer) | **{check-circle}** Yes | **{dotted-circle}** No | Used to show the configuration digest and the creation date in the tag details UI. |

| [Delete tag](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#delete-tag) | **{check-circle}** Yes | **{check-circle}** Yes | Used to delete a tag from the UI and in background (cleanup policies). |

| [Check API version](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#api-version-check) | {{< yes >}} | {{< yes >}} | Used globally to ensure that the registry supports the Docker Distribution V2 API, as well as for identifying whether GitLab Rails is talking to the GitLab container registry or a third-party one (used to toggle features only available in the former). |

| [List repository tags](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#listing-image-tags) | {{< yes >}} | {{< yes >}} | Used to list and show tags in the UI. Used to list tags in the background for [cleanup policies](../../../user/packages/container_registry/reduce_container_registry_storage.md#cleanup-policy) and [Geo replication](../../../administration/geo/replication/container_registry.md). |

| [Check if manifest exists](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#existing-manifests) | {{< yes >}} | {{< no >}} | Used to get the digest of a manifest by tag. This is then used to pull the manifest and show the tag details in the UI. |

| [Pull manifest](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#pulling-an-image-manifest) | {{< yes >}} | {{< no >}} | Used to show the image size and the manifest digest in the tag details UI. |

| [Pull blob](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#pulling-a-layer) | {{< yes >}} | {{< no >}} | Used to show the configuration digest and the creation date in the tag details UI. |

| [Delete tag](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#delete-tag) | {{< yes >}} | {{< yes >}} | Used to delete a tag from the UI and in background (cleanup policies). |



A valid authentication token is generated in GitLab Rails and embedded in all these requests before sending them to the registry.
@@ -222,22 +222,22 @@ This is a list of all the registry HTTP API operations and how they depend on th 


| Operation                                                                                                                      | Method   | Path                                    | Requires Database | Requires Storage | Used by GitLab Rails * |

|--------------------------------------------------------------------------------------------------------------------------------|----------|-----------------------------------------|-------------------|------------------|------------------------|

| [Check API version](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#api-version-check)         | `GET`    | `/v2/`                                  | **{dotted-circle}** No                 | **{dotted-circle}** No                | **{check-circle}** Yes                      |

| [List repositories](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#listing-repositories)      | `GET`    | `/v2/_catalog`                          | **{check-circle}** Yes                 | **{dotted-circle}** No                | **{dotted-circle}** No                      |

| [List repository tags](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#listing-image-tags)     | `GET`    | `/v2/<name>/tags/list`                  | **{check-circle}** Yes                 | **{dotted-circle}** No                | **{check-circle}** Yes                      |

| [Delete tag](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#delete-tag)                   | `DELETE` | `/v2/<name>/manifests/<reference>` | **{check-circle}** Yes                 | **{dotted-circle}** No                | **{check-circle}** Yes                      |

| [Check if manifest exists](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#existing-manifests) | `HEAD`   | `/v2/<name>/manifests/<reference>`      | **{check-circle}** Yes                 | **{dotted-circle}** No                | **{check-circle}** Yes                      |

| [Pull manifest](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#pulling-an-image-manifest)     | `GET`    | `/v2/<name>/manifests/<reference>`      | **{check-circle}** Yes                 | **{dotted-circle}** No                | **{check-circle}** Yes                      |

| [Push manifest](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#pushing-an-image-manifest)     | `PUT`    | `/v2/<name>/manifests/<reference>`      | **{check-circle}** Yes                 | **{dotted-circle}** No                | **{dotted-circle}** No                      |

| [Delete manifest](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#deleting-an-image)           | `DELETE` | `/v2/<name>/manifests/<reference>`      | **{check-circle}** Yes                 | **{dotted-circle}** No                | **{dotted-circle}** No                      |

| [Check if blob exists](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#existing-layers)        | `HEAD`   | `/v2/<name>/blobs/<digest>`             | **{check-circle}** Yes                 | **{dotted-circle}** No                | **{dotted-circle}** No                      |

| [Pull blob](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#fetch-blob)                        | `GET`    | `/v2/<name>/blobs/<digest>`             | **{check-circle}** Yes                 | **{check-circle}** Yes                | **{check-circle}** Yes                      |

| [Delete blob](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#delete-blob)                     | `DELETE` | `/v2/<name>/blobs/<digest>`             | **{check-circle}** Yes                 | **{dotted-circle}** No                | **{dotted-circle}** No                      |

| [Start blob upload](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#starting-an-upload)        | `POST`   | `/v2/<name>/blobs/uploads/`             | **{check-circle}** Yes                 | **{check-circle}** Yes                | **{dotted-circle}** No                      |

| [Check blob upload status](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#get-blob-upload)    | `GET`    | `/v2/<name>/blobs/uploads/<uuid>`       | **{check-circle}** Yes                 | **{check-circle}** Yes                | **{dotted-circle}** No                      |

| [Push blob chunk](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#chunked-upload-1)            | `PATCH`  | `/v2/<name>/blobs/uploads/<uuid>`       | **{check-circle}** Yes                 | **{check-circle}** Yes                | **{dotted-circle}** No                      |

| [Complete blob upload](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#put-blob-upload)        | `PUT`    | `/v2/<name>/blobs/uploads/<uuid>`       | **{check-circle}** Yes                 | **{check-circle}** Yes                | **{dotted-circle}** No                      |

| [Cancel blob upload](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#canceling-an-upload)      | `DELETE` | `/v2/<name>/blobs/uploads/<uuid>`       | **{check-circle}** Yes                 | **{check-circle}** Yes                | **{dotted-circle}** No                      |

| [Check API version](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#api-version-check)         | `GET`    | `/v2/`                                  | {{< no >}}                 | {{< no >}}                | {{< yes >}}                      |

| [List repositories](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#listing-repositories)      | `GET`    | `/v2/_catalog`                          | {{< yes >}}                 | {{< no >}}                 | {{< no >}}                      |

| [List repository tags](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#listing-image-tags)     | `GET`    | `/v2/<name>/tags/list`                  | {{< yes >}}                 | {{< no >}}                 | {{< yes >}}                      |

| [Delete tag](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#delete-tag)                   | `DELETE` | `/v2/<name>/manifests/<reference>` | {{< yes >}}                 | {{< no >}}                 | {{< yes >}}                      |

| [Check if manifest exists](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#existing-manifests) | `HEAD`   | `/v2/<name>/manifests/<reference>`      | {{< yes >}}                 | {{< no >}}                 | {{< yes >}}                      |

| [Pull manifest](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#pulling-an-image-manifest)     | `GET`    | `/v2/<name>/manifests/<reference>`      | {{< yes >}}                 | {{< no >}}                 | {{< yes >}}                      |

| [Push manifest](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#pushing-an-image-manifest)     | `PUT`    | `/v2/<name>/manifests/<reference>`      | {{< yes >}}                 | {{< no >}}                 | {{< no >}}                       |

| [Delete manifest](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#deleting-an-image)           | `DELETE` | `/v2/<name>/manifests/<reference>`      | {{< yes >}}                 | {{< no >}}                 | {{< no >}}                       |

| [Check if blob exists](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#existing-layers)        | `HEAD`   | `/v2/<name>/blobs/<digest>`             | {{< yes >}}                 | {{< no >}}                 | {{< no >}}                       |

| [Pull blob](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#fetch-blob)                        | `GET`    | `/v2/<name>/blobs/<digest>`             | {{< yes >}}                 | {{< yes >}}                | {{< yes >}}                      |

| [Delete blob](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#delete-blob)                     | `DELETE` | `/v2/<name>/blobs/<digest>`             | {{< yes >}}                 | {{< no >}}                 | {{< no >}}                       |

| [Start blob upload](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#starting-an-upload)        | `POST`   | `/v2/<name>/blobs/uploads/`             | {{< yes >}}                 | {{< yes >}}                | {{< no >}}                       |

| [Check blob upload status](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#get-blob-upload)    | `GET`    | `/v2/<name>/blobs/uploads/<uuid>`       | {{< yes >}}                 | {{< yes >}}                | {{< no >}}                       |

| [Push blob chunk](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#chunked-upload-1)            | `PATCH`  | `/v2/<name>/blobs/uploads/<uuid>`       | {{< yes >}}                 | {{< yes >}}                | {{< no >}}                      |

| [Complete blob upload](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#put-blob-upload)        | `PUT`    | `/v2/<name>/blobs/uploads/<uuid>`       | {{< yes >}}                 | {{< yes >}}                | {{< no >}}                      |

| [Cancel blob upload](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs/spec/api.md#canceling-an-upload)      | `DELETE` | `/v2/<name>/blobs/uploads/<uuid>`       | {{< yes >}}                 | {{< yes >}}                | {{< no >}}                       |



`*` Refer to the [list of interactions between registry and Rails](#from-gitlab-rails-to-registry) to know why and how.

content/handbook/engineering/architecture/design-documents/gitlab_ml_experiments/_index.md

+21 −21

File changed.

Preview size limit exceeded, changes collapsed.

layouts/_shortcodes/no.html

0 → 100644
+6 −0
Changes for layouts/_shortcodes/no.html: 6 added lines, 0 removed lines.
Original line number Diff line number Diff line 
{{- /*

  Feature-table "no" marker, modelled on the {{< no >}} shortcode on docs.gitlab.com.

  https://docs.gitlab.com/development/documentation/styleguide/#feature-tables

  Renders a visible dash icon and a hidden span for screen readers.

*/ -}}

<i class="fas fa-minus" aria-hidden="true"></i><span class="visually-hidden">no</span>

layouts/_shortcodes/yes.html

0 → 100644
+6 −0
Changes for layouts/_shortcodes/yes.html: 6 added lines, 0 removed lines.
Original line number Diff line number Diff line 
{{- /*

  Feature-table "yes" marker, matching the {{< yes >}} shortcode on docs.gitlab.com.

  https://docs.gitlab.com/development/documentation/styleguide/#feature-tables

  Renders a visible checkmark icon and a hidden span for screen readers.

*/ -}}

<i class="fas fa-check" aria-hidden="true"></i><span class="visually-hidden">yes</span>