2018-05-09 07:07:11 -04:00
---
2020-10-29 17:08:54 -04:00
stage: none
group: unassigned
2020-11-26 01:09:20 -05:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-07-29 08:09:45 -04:00
type: reference, index
2018-05-09 07:07:11 -04:00
description: 'Read through the GitLab User documentation to learn how to use, configure, and customize GitLab and GitLab.com to your own needs.'
---
2021-03-12 16:09:12 -05:00
# User Docs **(FREE)**
2017-07-26 04:02:11 -04:00
Welcome to GitLab! We're glad to have you here!
2020-11-19 22:09:15 -05:00
As a GitLab user you have access to all the features
2018-07-02 20:37:24 -04:00
your [subscription ](https://about.gitlab.com/pricing/ )
2019-03-03 19:17:57 -05:00
includes, except [GitLab administrator ](../administration/index.md )
2017-07-26 04:02:11 -04:00
settings, unless you have admin privileges to install, configure,
and upgrade your GitLab instance.
2019-02-08 06:11:54 -05:00
Admin privileges for [GitLab.com ](https://gitlab.com/ ) are restricted to the GitLab team.
2017-07-26 04:02:11 -04:00
2020-03-06 19:08:25 -05:00
For more information on configuring GitLab self-managed instances, see the [Administrator documentation ](../administration/index.md ).
2017-07-26 04:02:11 -04:00
## Overview
2019-02-08 06:11:54 -05:00
GitLab is a fully integrated software development platform that enables your team to be transparent, fast, effective, and cohesive from discussion on a new idea to production, all on the same platform.
2017-07-26 04:02:11 -04:00
2019-02-08 06:11:54 -05:00
For more information, see [All GitLab Features ](https://about.gitlab.com/features/ ).
2017-07-26 04:02:11 -04:00
2018-01-15 13:11:02 -05:00
### Concepts
2019-02-08 06:11:54 -05:00
To get familiar with the concepts needed to develop code on GitLab, read the following articles:
2018-01-15 13:11:02 -05:00
2019-10-16 11:06:17 -04:00
- [Demo: Mastering Code Review With GitLab ](https://about.gitlab.com/blog/2017/03/17/demo-mastering-code-review-with-gitlab/ ).
2021-02-19 19:10:55 -05:00
- [GitLab Workflow: An Overview ](https://about.gitlab.com/topics/version-control/what-is-gitlab-workflow/#gitlab-workflow-a-use-case-scenario ).
2019-10-16 11:06:17 -04:00
- [Tutorial: It's all connected in GitLab ](https://about.gitlab.com/blog/2016/03/08/gitlab-tutorial-its-all-connected/ ): an overview on code collaboration with GitLab.
- [Trends in Version Control Land: Microservices ](https://about.gitlab.com/blog/2016/08/16/trends-in-version-control-land-microservices/ ).
2021-02-19 19:10:55 -05:00
- [Trends in Version Control Land: Innersourcing ](https://about.gitlab.com/topics/version-control/what-is-innersource/ ).
2018-01-15 13:11:02 -05:00
2017-07-26 04:02:11 -04:00
## Use cases
2018-01-15 13:11:02 -05:00
GitLab is a Git-based platform that integrates a great number of essential tools for software development and deployment, and project management:
2017-07-26 04:02:11 -04:00
2019-03-25 00:29:51 -04:00
- Hosting code in repositories with version control.
2019-02-08 06:11:54 -05:00
- Tracking proposals for new implementations, bug reports, and feedback with a
2021-03-24 11:09:19 -04:00
fully featured [Issue tracker ](project/issues/index.md ).
2021-01-22 13:09:10 -05:00
- Organizing and prioritizing with [Issue Boards ](project/issue_board.md ).
2019-02-08 06:11:54 -05:00
- Reviewing code in [Merge Requests ](project/merge_requests/index.md ) with live-preview changes per
2019-03-25 00:29:51 -04:00
branch with [Review Apps ](../ci/review_apps/index.md ).
- Building, testing, and deploying with built-in [Continuous Integration ](../ci/README.md ).
- Deploying personal and professional static websites with [GitLab Pages ](project/pages/index.md ).
2019-09-17 08:06:48 -04:00
- Integrating with Docker by using [GitLab Container Registry ](packages/container_registry/index.md ).
2020-10-02 05:08:33 -04:00
- Tracking the development lifecycle by using [GitLab Value Stream Analytics ](analytics/value_stream_analytics.md ).
2020-07-17 02:09:11 -04:00
- Provide support with [Service Desk ](project/service_desk.md ).
2020-09-22 11:09:37 -04:00
- [Export issues as CSV ](project/issues/csv_export.md ).
2017-07-26 04:02:11 -04:00
With GitLab Enterprise Edition, you can also:
2019-10-31 05:06:29 -04:00
- Improve collaboration with:
2021-04-28 17:10:01 -04:00
- [Merge Request Approvals ](project/merge_requests/approvals/index.md ).
2021-03-12 16:09:12 -05:00
- [Multiple Assignees for Issues ](project/issues/multiple_assignees_for_issues.md ).
2019-10-31 05:06:29 -04:00
- [Multiple Issue Boards ](project/issue_board.md#multiple-issue-boards ).
2021-04-06 14:09:02 -04:00
- Create formal relationships between issues with [linked issues ](project/issues/related_issues.md ).
2020-12-02 16:09:44 -05:00
- Use [Burndown Charts ](project/milestones/burndown_and_burnup_charts.md ) to track progress during a sprint or while working on a new version of their software.
2021-03-02 19:10:50 -05:00
- Leverage [Elasticsearch ](../integration/elasticsearch.md ) with [Advanced Search ](search/advanced_search.md ) for faster, more advanced code search across your entire GitLab instance.
2019-05-31 07:26:18 -04:00
- [Authenticate users with Kerberos ](../integration/kerberos.md ).
2019-10-27 02:06:30 -04:00
- [Mirror a repository ](project/repository/repository_mirroring.md ) from elsewhere on your local server.
2020-09-28 02:09:56 -04:00
- View your entire CI/CD pipeline involving more than one project with [Multiple-Project Pipelines ](../ci/multi_project_pipelines.md ).
2019-05-31 07:26:18 -04:00
- [Lock files ](project/file_lock.md ) to prevent conflicts.
- View the current health and status of each CI environment running on Kubernetes with [Deploy Boards ](project/deploy_boards.md ).
- Leverage continuous delivery method with [Canary Deployments ](project/canary_deployments.md ).
- Scan your code for vulnerabilities and [display them in merge requests ](application_security/sast/index.md ).
2017-07-26 04:02:11 -04:00
2021-03-30 08:10:51 -04:00
You can also [integrate ](project/integrations/overview.md ) GitLab with numerous third-party applications, such as Mattermost, Microsoft Teams, Trello, Slack, Bamboo CI, Jira, and a lot more.
2017-07-26 04:02:11 -04:00
2020-11-05 10:09:04 -05:00
## User types
There are several types of users in GitLab:
- Regular users and GitLab.com users. <!-- Note: further description TBA -->
- [Groups ](group/index.md ) of users.
- GitLab [admin area ](admin_area/index.md ) user.
- [GitLab Administrator ](../administration/index.md ) with full access to
self-managed instances' features and settings.
- [Internal users ](../development/internal_users.md ).
2021-02-15 16:08:59 -05:00
## User activity
2021-03-12 16:09:12 -05:00
You can follow or unfollow other users from their [user profiles ](profile/index.md#access-your-user-profile ).
2021-04-22 14:10:13 -04:00
To view a user's activity in a top-level Activity view:
2021-02-15 16:08:59 -05:00
2021-04-22 14:10:13 -04:00
1. From a user's profile, select **Follow** .
1. In the GitLab menu, select **Activity** .
1. Select the **Followed users** tab.
2021-02-15 16:08:59 -05:00
2017-07-26 04:02:11 -04:00
## Projects
2019-02-08 06:11:54 -05:00
In GitLab, you can create [projects ](project/index.md ) to host
your code, track issues, collaborate on code, and continuously
2017-07-26 04:02:11 -04:00
build, test, and deploy your app with built-in GitLab CI/CD. Or, you can do
it all at once, from one single project.
2017-08-11 02:17:02 -04:00
- [Repositories ](project/repository/index.md ): Host your codebase in
2019-02-22 08:17:10 -05:00
repositories with version control and as part of a fully integrated platform.
2017-08-11 02:17:02 -04:00
- [Issues ](project/issues/index.md ): Explore the best of GitLab Issues' features.
- [Merge Requests ](project/merge_requests/index.md ): Collaborate on code,
2019-02-22 08:17:10 -05:00
reviews, live preview changes per branch, and request approvals with Merge Requests.
2017-08-11 02:17:02 -04:00
- [Milestones ](project/milestones/index.md ): Work on multiple issues and merge
2019-02-22 08:17:10 -05:00
requests towards the same target date with Milestones.
2017-07-26 04:02:11 -04:00
## Account
There is a lot you can customize and configure
to enjoy the best of GitLab.
2020-04-07 23:09:31 -04:00
- [Settings ](profile/index.md ): Manage your user settings to change your personal information,
2019-02-22 08:17:10 -05:00
personal access tokens, authorized applications, etc.
2017-08-11 02:17:02 -04:00
- [Authentication ](../topics/authentication/index.md ): Read through the authentication
2019-02-22 08:17:10 -05:00
methods available in GitLab.
2017-08-11 02:17:02 -04:00
- [Permissions ](permissions.md ): Learn the different set of permissions levels for each
2019-02-22 08:17:10 -05:00
user type (guest, reporter, developer, maintainer, owner).
2018-01-10 23:16:27 -05:00
- [Feature highlight ](feature_highlight.md ): Learn more about the little blue dots
2019-05-05 09:07:20 -04:00
around the app that explain certain features.
2021-04-21 14:11:09 -04:00
- [Abuse reports ](report_abuse.md ): Report abuse from users to GitLab administrators.
2017-07-26 04:02:11 -04:00
2017-08-11 02:17:02 -04:00
## Groups
2017-07-26 04:02:11 -04:00
2017-08-11 02:17:02 -04:00
With GitLab [Groups ](group/index.md ) you can assemble related projects together
and grant members access to several projects at once.
2017-07-26 04:02:11 -04:00
2017-08-11 02:17:02 -04:00
Groups can also be nested in [subgroups ](group/subgroups/index.md ).
2017-07-26 04:02:11 -04:00
## Discussions
In GitLab, you can comment and mention collaborators in issues,
merge requests, code snippets, and commits.
When performing inline reviews to implementations
to your codebase through merge requests you can
2019-07-15 02:10:32 -04:00
gather feedback through [resolvable threads ](discussions/index.md#resolvable-comments-and-threads ).
2017-07-26 04:02:11 -04:00
2017-08-18 15:44:51 -04:00
### GitLab Flavored Markdown (GFM)
Read through the [GFM documentation ](markdown.md ) to learn how to apply
2019-07-15 02:10:32 -04:00
the best of GitLab Flavored Markdown in your threads, comments,
2019-10-22 23:06:01 -04:00
issues and merge requests descriptions, and everywhere else GFM is
2017-08-18 15:44:51 -04:00
supported.
2020-09-16 11:09:32 -04:00
## To-Do List
2017-07-26 04:02:11 -04:00
2020-09-16 11:09:32 -04:00
Never forget to reply to your collaborators. [GitLab To-Do List ](todos.md )
is a tool for working faster and more effectively with your team,
2017-07-26 04:02:11 -04:00
by listing all user or group mentions, as well as issues and merge
requests you're assigned to.
2017-08-21 14:34:52 -04:00
## Search
[Search and filter ](search/index.md ) through groups, projects, issues, merge requests, files, code, and more.
2017-07-26 04:02:11 -04:00
## Snippets
[Snippets ](snippets.md ) are code blocks that you want to store in GitLab, from which
you have quick access to. You can also gather feedback on them through
2020-07-09 14:10:09 -04:00
[Discussions ](#discussions ).
2017-07-26 04:02:11 -04:00
2020-10-23 11:08:42 -04:00
## GitLab CI/CD
Use built-in [GitLab CI/CD ](../ci/README.md ) to test, build, and deploy your applications
directly from GitLab. No third-party integrations needed.
2020-08-21 14:10:24 -04:00
## Features behind feature flags
Understand what [features behind feature flags ](feature_flags.md ) mean.
2019-10-28 02:06:30 -04:00
## Keyboard shortcuts
There are many [keyboard shortcuts ](shortcuts.md ) in GitLab to help you navigate between
pages and accomplish tasks faster.
2017-08-11 02:17:02 -04:00
## Integrations
2021-05-03 14:10:17 -04:00
[Integrate GitLab ](../integration/index.md ) with your preferred tool,
2019-06-28 09:25:56 -04:00
such as Trello, Jira, etc.
2017-08-11 02:17:02 -04:00
2017-07-26 04:02:11 -04:00
## Webhooks
2018-06-07 15:35:05 -04:00
Configure [webhooks ](project/integrations/webhooks.md ) to listen for
2020-11-19 22:09:15 -05:00
specific events like pushes, issues or merge requests. GitLab sends a
2017-07-26 04:02:11 -04:00
POST request with data to the webhook URL.
## API
2018-06-07 15:35:05 -04:00
Automate GitLab via [API ](../api/README.md ).
2017-07-26 04:02:11 -04:00
2017-08-11 02:17:02 -04:00
## Git and GitLab
Learn what is [Git ](../topics/git/index.md ) and its best practices.
2018-08-16 10:27:21 -04:00
2020-08-21 14:10:24 -04:00
## Instance-level analytics
2018-08-16 10:27:21 -04:00
2020-08-21 14:10:24 -04:00
See [various statistics ](admin_area/analytics/index.md ) of your GitLab instance.
2019-05-05 09:07:20 -04:00
2021-03-12 16:09:12 -05:00
## Operations Dashboard
2019-05-05 09:07:20 -04:00
See [Operations Dashboard ](operations_dashboard/index.md ) for a summary of each
project's operational health.