Set up your authoring environment contribute

Set up your environment for writing and previewing GitLab documentation.

You can use whichever tools you’re most comfortable with. Use this guidance to help ensure you have the tools you need.

• Install a code editor, like VS Code or Sublime Text, to work with Markdown files.
• Install Git and add an SSH key to your GitLab profile.
• Install documentation linters and configure them in your code editor:
  • markdownlint
  • Vale
• Set up the docs site to build locally.
• Optional. Install the Conventional Comments extension for Chrome. The plugin adds Conventional Comment buttons to GitLab comments.

After you’re comfortable with your toolset, you can install the GitLab Development Kit (GDK), a fully functional self-managed version of GitLab.

You can use GDK to:

• Preview documentation changes locally.
• Preview code changes locally.