Skip to content

Decide and document blessed way of consuming gitlab/ui SCSS

Background

There's a short section on how to consume gitlab-ui in a project.

Styles are an integral part of consuming this library; but there's no mention of it.

Currently gitlab is importing @gitlab/ui/src/scss/gitlab_ui which relies on the internal file structure of gitlab-ui (Although I don't expect that particular path to change).

This makes it awkward for other projects (Customer Portal) to consume and use SCSS from gitlab-ui.

Suggestion

Decide on a public API for consuming SCSS, and document it. Changing the import path should then follow semver and be a breaking change.