GitLab integration

Mention GitLab issues and merges in Slab

Updated over a week ago

Why integrate with GitLab?

  • Sync Markdown files (*.md) to Slab to organize and search them alongside your other documentation.

  • Mention GitLab Issues and Merge Requests and view context—such as open status, assignee, etc.—directly in Slab.

Sync GitLab markdown files

Engineering teams often store Getting Started and troubleshooting guides in GitLab as markdown files or READMEs. This leads to silos between your GitLab content and the rest of your documentation.

With Slab, you can sync READMEs and all .md files from GitLab and organize and search them in the same way you would posts in Slab. You can add topics to GitLab posts, verify them, add them to series, share them (including publicly), and export them!

If you try to edit a synced post, we'll kick you back to GitLab so you can keep your version control on those mission-critical docs.

✏️ Note: To enable this feature, a one-time setup by your admin is required. See the Admin setup guide below for details.

Mentions in Slab posts

To mention a GitLab issue or merge, copy its link from your browser address bar. Paste the link inside a Slab post, and you will see it automatically unfurled into a dynamic mention! Hovering over the mention will open a preview with more details.

✏️ Note: To enable this feature, a one-time setup by your admin is required. See the Admin setup guide below for details.

Admin setup guide

As an admin, you can set up the GitLab integration for your team to use, and control their permissions:

  1. Click your team name in the top-left corner of the sidebar.

  2. Click Team settings in the dropdown menu.

  3. Click on the Integrations tab, and find GitLab in the list of integrations.

  4. Click Modify or Enable and follow the instructions in the modal to finish enabling the integration.

  5. Under the Mentions tab, you can control which projects your team can mention from.

  6. Under the Sync tab, you can control which repositories to sync markdown files from.

✏️ Note: We require a GitLab token with the api scope. This is a read + write scope that allows Slab to create the webhooks necessary to listen for changes in your GitLab repositories and sync them to Slab.

Did this answer your question?