Design Management

Warning: This an alpha feature and is subject to change at any time without prior notice.

Overview

Design Management allows you to upload design assets (wireframes, mockups, etc.) to GitLab issues and keep them stored in one single place, accessed by the Design Management’s page within an issue, giving product designers, product managers, and engineers a way to collaborate on designs over one single source of truth.

You can easily share mock-ups of designs with your team, or visual regressions can be easily viewed and addressed.

For an overview, see the video Design Management (GitLab 12.2).

Requirements

Design Management requires Large File Storage (LFS) to be enabled:

  • For GitLab.com, LFS is already enabled.
  • For self-managed instances, a GitLab administrator must have enabled LFS globally.
  • For both GitLab.com and self-managed instances: LFS must be enabled for the project itself. If enabled globally, LFS will be enabled by default to all projects. To enable LFS on the project level, navigate to your project’s Settings > General, expand Visibility, project features, permissions and enable Git Large File Storage.

Limitations

The Design Management page

Navigate to the Design Management page from any issue by clicking the Designs tab:

Designs tab

Adding designs

To upload design images, click the Upload Designs button and select images to upload.

Designs with the same filename as an existing uploaded design will create a new version of the design, and will replace the previous version.

Designs cannot be added if the issue has been moved, or its discussion is locked.

Viewing designs

Images on the Design Management page can be enlarged by clicking on them.

The number of comments on a design — if any — is listed to the right of the design filename. Clicking on this number enlarges the design just like clicking anywhere else on the design. When a design is added or modified, an icon is displayed on the item to help summarize changes between versions.

Indicator Example
Comments Comments Icon
Modified (in the selected version) Design Modified
Added (in the selected version) Design Added

Deleting designs

There are two ways to delete designs: manually delete them individually, or select a few of them to delete at once, as shown below.

To delete a single design, click it to view it enlarged, then click the trash icon on the top right corner and confirm the deletion by clicking the Delete button on the modal window:

Confirm design deletion

To delete multiple designs at once, on the design’s list view, first select the designs you want to delete:

Select designs

Once selected, click the Delete selected button to confirm the deletion:

Delete multiple designs

Note: Only the latest version of the designs can be deleted. Deleted designs are not permanently lost; they can be viewed by browsing previous versions.

Adding annotations to designs

When a design image is displayed, you can add annotations to it by clicking on the image. A badge is added to the image and a form is displayed to start a new discussion. For example:

Starting a new discussion on design

When submitted, the form saves a badge linked to the discussion on the image. Different discussions have different badge numbers. For example:

Discussions on design annotations