index.md 8.99 KB
Newer Older
1 2 3 4
---
description: 'Read through the GitLab User documentation to learn how to use, configure, and customize GitLab and GitLab.com to your own needs.'
---

5 6 7 8 9
# User documentation

Welcome to GitLab! We're glad to have you here!

As a GitLab user you'll have access to all the features
10
your [subscription](https://about.gitlab.com/pricing/)
11
includes, except [GitLab administrator](../administration/index.md)
12 13 14
settings, unless you have admin privileges to install, configure,
and upgrade your GitLab instance.

15
Admin privileges for [GitLab.com](https://gitlab.com/) are restricted to the GitLab team.
16

17
For more information on configuring GitLab self-managed instances, see [Administrator documentation](../administration/index.md).
18 19 20

## Overview

21
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.
22

23
For more information, see [All GitLab Features](https://about.gitlab.com/features/).
24

25 26
### Concepts

27
To get familiar with the concepts needed to develop code on GitLab, read the following articles:
28

29 30
- [Demo: Mastering Code Review With GitLab](https://about.gitlab.com/2017/03/17/demo-mastering-code-review-with-gitlab/).
- [GitLab Workflow: An Overview](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/#gitlab-workflow-use-case-scenario).
31 32 33 34
- [Tutorial: It's all connected in GitLab](https://about.gitlab.com/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/2016/08/16/trends-in-version-control-land-microservices/).
- [Trends in Version Control Land: Innersourcing](https://about.gitlab.com/2016/07/07/trends-version-control-innersourcing/).

35 36
## Use cases

37
GitLab is a Git-based platform that integrates a great number of essential tools for software development and deployment, and project management:
38

39 40
- Hosting code in repositories with version control
- Tracking proposals for new implementations, bug reports, and feedback with a
41
  fully featured [Issue Tracker](project/issues/index.md#issue-tracker)
42 43
- Organizing and prioritizing with [Issue Boards](project/issues/index.md#issue-boards)
- Reviewing code in [Merge Requests](project/merge_requests/index.md) with live-preview changes per
44
  branch with [Review Apps](../ci/review_apps/index.md)
45 46 47 48
- 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)
- Integrating with Docker by using [GitLab Container Registry](project/container_registry.md)
- Tracking the development lifecycle by usingn [GitLab Cycle Analytics](project/cycle_analytics.md)
49 50 51 52 53

With GitLab Enterprise Edition, you can also:

- Provide support with [Service Desk](https://docs.gitlab.com/ee/user/project/service_desk.html)
- Improve collaboration with
54 55 56
  [Merge Request Approvals](https://docs.gitlab.com/ee/user/project/merge_requests/index.html#merge-request-approvals),
  [Multiple Assignees for Issues](https://docs.gitlab.com/ee/user/project/issues/multiple_assignees_for_issues.html),
  and [Multiple Issue Boards](https://docs.gitlab.com/ee/user/project/issue_board.html#multiple-issue-boards)
Pascal Borreli's avatar
Pascal Borreli committed
57
- Create formal relationships between issues with [Related Issues](https://docs.gitlab.com/ee/user/project/issues/related_issues.html)
58 59 60 61 62 63 64
- Use [Burndown Charts](https://docs.gitlab.com/ee/user/project/milestones/burndown_charts.html) to track progress during a sprint or while working on a new version of their software.
- Leverage [Elasticsearch](https://docs.gitlab.com/ee/integration/elasticsearch.html) with [Advanced Global Search](https://docs.gitlab.com/ee/user/search/advanced_global_search.html) and [Advanced Syntax Search](https://docs.gitlab.com/ee/user/search/advanced_search_syntax.html) for faster, more advanced code search across your entire GitLab instance
- [Authenticate users with Kerberos](https://docs.gitlab.com/ee/integration/kerberos.html)
- [Mirror a repository](https://docs.gitlab.com/ee/workflow/repository_mirroring.html) from elsewhere on your local server.
- [Export issues as CSV](https://docs.gitlab.com/ee/user/project/issues/csv_export.html)
- View your entire CI/CD pipeline involving more than one project with [Multiple-Project Pipeline Graphs](https://docs.gitlab.com/ee/ci/multi_project_pipeline_graphs.html)
- [Lock files](https://docs.gitlab.com/ee/user/project/file_lock.html) to prevent conflicts
65 66
- View the current health and status of each CI environment running on Kubernetes with [Deploy Boards](https://docs.gitlab.com/ee/user/project/deploy_boards.html)
- Leverage continuous delivery method with [Canary Deployments](https://docs.gitlab.com/ee/user/project/canary_deployments.html)
67

68
You can also [integrate](project/integrations/project_services.md) GitLab with numerous third-party applications, such as Mattermost, Microsoft Teams, HipChat, Trello, Slack, Bamboo CI, JIRA, and a lot more.
69 70 71

## Projects

72 73
In GitLab, you can create [projects](project/index.md) to host
your code, track issues, collaborate on code, and continuously
74 75 76
build, test, and deploy your app with built-in GitLab CI/CD. Or, you can do
it all at once, from one single project.

77
- [Repositories](project/repository/index.md): Host your codebase in
78
  repositories with version control and as part of a fully integrated platform.
79 80
- [Issues](project/issues/index.md): Explore the best of GitLab Issues' features.
- [Merge Requests](project/merge_requests/index.md): Collaborate on code,
81
  reviews, live preview changes per branch, and request approvals with Merge Requests.
82
- [Milestones](project/milestones/index.md): Work on multiple issues and merge
83
  requests towards the same target date with Milestones.
84 85 86 87 88 89

## 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.

90 91 92
- [GitLab Auto Deploy](../ci/autodeploy/index.md): Deploy your application out-of-the-box with GitLab Auto Deploy.
- [Review Apps](../ci/review_apps/index.md): Live-preview the changes introduced by a merge request with Review Apps.
- [GitLab Pages](project/pages/index.md): Publish your static site directly from
93
  GitLab with GitLab Pages. You can build, test, and deploy any Static Site Generator with Pages.
94
- [GitLab Container Registry](project/container_registry.md): Build and deploy Docker
95
  images with Container Registry.
96 97 98 99 100 101

## Account

There is a lot you can customize and configure
to enjoy the best of GitLab.

102
- [Settings](profile/index.md): Manage your user settings to change your personal info,
103
  personal access tokens, authorized applications, etc.
104
- [Authentication](../topics/authentication/index.md): Read through the authentication
105
  methods available in GitLab.
106
- [Permissions](permissions.md): Learn the different set of permissions levels for each
107
  user type (guest, reporter, developer, maintainer, owner).
108
- [Feature highlight](feature_highlight.md): Learn more about the little blue dots
109
  around the app that explain certain features
110
- [Abuse reports](abuse_reports.md): Report abuse from users to GitLab administrators
111

112
## Groups
113

114 115
With GitLab [Groups](group/index.md) you can assemble related projects together
and grant members access to several projects at once.
116

117
Groups can also be nested in [subgroups](group/subgroups/index.md).
118 119 120 121 122 123 124 125 126 127

## 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
gather feedback through [resolvable discussions](discussions/index.md#resolvable-discussions).

128 129 130 131 132 133 134
### GitLab Flavored Markdown (GFM)

Read through the [GFM documentation](markdown.md) to learn how to apply
the best of GitLab Flavored Markdown in your discussions, comments,
issues and merge requests descriptions, and everywhere else GMF is
supported.

135 136 137 138 139 140 141
## Todos

Never forget to reply to your collaborators. [GitLab Todos](../workflow/todos.md)
are a tool for working faster and more effectively with your team,
by listing all user or group mentions, as well as issues and merge
requests you're assigned to.

142 143 144 145
## Search

[Search and filter](search/index.md) through groups, projects, issues, merge requests, files, code, and more.

146 147 148 149 150 151
## 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
[discussions](#discussions).

152 153 154 155 156
## Integrations

[Integrate GitLab](../integration/README.md) with your preferred tool,
such as Trello, JIRA, etc.

157 158
## Webhooks

159
Configure [webhooks](project/integrations/webhooks.md) to listen for
160 161 162 163 164
specific events like pushes, issues or merge requests. GitLab will send a
POST request with data to the webhook URL.

## API

165
Automate GitLab via [API](../api/README.md).
166

167 168 169
## Git and GitLab

Learn what is [Git](../topics/git/index.md) and its best practices.
Luke Bennett's avatar
Luke Bennett committed
170 171 172 173

## Instance statistics

See [various statistics](instance_statistics/index.md) of your GitLab instance.