summaryrefslogtreecommitdiff
path: root/doc/user/project/index.md
blob: b2b284c6a09b86063cabd3d1651ca0e851b08b5b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# Project

A **GitLab Project** is a complete tool for project
management **with** version control **and** continuous methods.

## Project's features

Your work in GitLab starts with a project. From there,
you can, for example, use it as an Issue Tracker, create code snippets, or
host your code with version control in a Git-based platform.

Beyond hosting your code, with GitLab Projects you can, among other powerful [features]():

- Discuss implementations with your team with [GitLab Issues]()
  - Discuss privately with [Confidential Issues]()
- Plan ahead, organize, collaborate
  - Organize issues and merge requests by giving them [Labels]()
  - Manage your workflow and prioritize issues with [Issue Boards]()
  - Enhance the workflow capability of Issue Boards with [Multiple Issue Boards]() (EES/EEP)
  - [Assign]() issues and merge requests to a team member or to [multiple people]()
  - Use [Time Tracking]() to track estimate time and time spent on
  the conclusion of an issue or merge request
  - Work towards a target date with [Milestones]()
- Host your code in repositories with [Git]() version control
  - Easily apply Git commands from the UI
     - [Revert]()
     - [Cherry-pick]()
  - Manage [branches]()
  - [Squash and merge]()
- Push code with [Merge Requests]()
  - [Merge Request Approvals]()
  - [Fix merge conflicts from the UI]()
- Preview the results of the changes proposed in a merge request
  in a per-branch basis with [Review Apps]()
- Built-in [Continuous Integration, Delivery, and Deployment]() with [GitLab CI]()
  - Browse and download [job artifacts]()
  - [Environments]()
  - [Auto Deploy]()
  - Visualize the CI flow with Pipelines
     - [Scheduled Pipelines]()
     - [Pipeline Charts]()
- Review the development lifecycle with [Cycle Analytics]()

## Project's dashboard

Every project in GitLab has powerful built-in features, accessed from the project's dashboard.

Access your project's dashboard (project's home page) under `https://gitlab.com/namespace/project-name`.

The project's dashboard displays the following information:

![project's dashboard screenshot](img/project_view_numbered.png)

From the project's dashboard, you have access to the following information:

### 1. Project's name

This is the first information found on the left screen:

- User/group name
- Project's name

The username or groupname are called `namespaces`, which can be changed
from the project's settings.

When you create a new project, you'll be prompted to choose which namespace
you'd like to create your project under.

### 2. Search bar

Use the search bar to search through issues and merge
requests assigned to you within the project

### 3. Project's features bar

Navigate through the project's [features and settings](#project-features).

- [Repository](repository/index.md)
  - Files
  - Commits
  - Branches
  - Tags (manage tags, release notes, changelog)
  - Contributors (project's members contributions)
  - Graph (Git revision graph)
  - Compare (compare branches)
  - Charts (Programming languages, commit statistics)
  - Locked Files (EEP)
- [Registry]() (Container Registry settings)
- [Issues](issues/index.md)
  - Tracker (list of issues)
  - [Issue Boards]()
  - [Labels]()
  - [Milestones]()
- [Merge Requests](merge_requests/index.md)
- [Pipelines]()
  - Pipelines
  - [Jobs]()
  - [Schedules]()
  - [Environments]()
  - [Charts]()
- [Wiki]()
- [Snippets]()
- [Settings]()
  - General
  - Members
  -[Integrations (Services)
  - Repository
  - Pipelines
  - Pages
  - Audit Events

### 4. Project's activity

- Access the project's homepage
- View the projects' members activity
- View [Cycle Analytics]()

### 5. Project's description

- Project's avatar
- Project's title (name)
- Project's description

To adjust these entries, from the project's dashboard, navigate to **Settings**.

### 6. Project's details

- Project's popularity (number of forks and stars)
- Path (https or [SSH]()) to access the project remotely
- Link to download the project's default branch (available in `zip`, `tar.gz`, `tar.bz2`, `tar`)
- Shortcut `+` button: add a new issue, new merge request, new file, new branch or new tag
- Project's [notifications]() level

### 7. Leave project

**Leave project** will only display when a project is part of a group.
If you choose to leave a project you will no longer be a project member,
therefore, unable to contribute.

### 8. Repository details

- Project's size (bytes), number of commits, branches, and tags
- Files
  - Continuous Integration (GitLab CI configuration): a link to `.gitlab-ci.yml` (or to add a new one)
  - Changelog: a link to `CHANGELOG` (or to add a new one)
  - License: a link to `LICENSE` (or to add a new one)
  - Contribution guide: a link to `CONTRIBUTING.md` (or to add a new one)
- Latest commit and pipeline status (if GitLab CI is configured)

### 9. Branches

- Branch dropdown menu
- Shortcuts:
  - Plus sign `+`: add new file, upload file, new directory, new branch, or new tag

### 10. Search, download

- Find file: search though the project's files
- View commit history
- Download the project (a chosen branch, available in `zip`, `tar.gz`, `tar.bz2`, `tar`)

### 11. Latest commit

Displays the latest commit pushed to the project, together with its author and its date/time.

### 12. Files

Displays the files in alphabetical order, besides the last commit for each file, and the time/date it was pushed to the repository.

## New project

Learn how to create a new project in GitLab

## Fork a project

- Collaborate on code by forking a project and creating a merge request from your fork to the upstream project
- Fork a sample project to work on the top of that

## Import or Export a project

- Import a project from:
  - [GitHub to GitLab](../workflow/importing/import_projects_from_github.md)
  - [BitBucket to GitLab](../workflow/importing/import_projects_from_bitbucket.md)
  - [Gitea to GitLab](../workflow/importing/import_projects_from_gitea.md
  - [FogBugz to GitLab](../workflow/importing/import_projects_from_fogbugz.md)
- [Export a project from GitLab](project/settings/import_export.md#exporting-a-project-and-its-data)