Skip to content

G
gitlab-ce
Commit bcd89a0d authored by Evan Read's avatar Evan Read
Browse files
Options

Implement review feedback 

Also:

- Replace DevOps image with one with all stages.
- Further restructure page.
- Edit and tabulate lower part of page.
parent 0e8a00cd
Hide whitespace changes
Inline Side-by-side
Showing with 148 additions and 134 deletions
doc/README.md
View file @ bcd89a0d
...@@ -18,36 +18,36 @@ No matter how you use GitLab, we have documentation for you. ...@@ -18,36 +18,36 @@ No matter how you use GitLab, we have documentation for you.
<tbody> <tbody>
<tr> <tr>
<td width="50%"> <td width="50%">
<a href="user/index.md"><strong>User documentation</strong> <i class="fa fa-gitlab" aria-hidden="true"></i></a> <a href="user/index.md"><strong>User documentation</strong></a>
<br/> <br/>
Discover features and concepts for GitLab users. Discover features and concepts for GitLab users.
</td> </td>
<td width="50%"> <td width="50%">
<a href="administration/index.md"><strong>Administrator documentation</strong> <i class="fa fa-gitlab" aria-hidden="true"></i></a> <a href="administration/index.md"><strong>Administrator documentation</strong></a>
<br/> <br/>
Everything GitLab administrators need to know. Everything GitLab administrators need to know.
</td> </td>
</tr> </tr>
<tr> <tr>
<td width="50%"> <td width="50%">
<a href="#contributing-to-gitlab"><strong>Contributing to GitLab</strong> <i class="fa fa-gitlab" aria-hidden="true"></i></a> <a href="#contributing-to-gitlab"><strong>Contributing to GitLab</strong></a>
<br/> <br/>
At GitLab, everyone can contribute! At GitLab, everyone can contribute!
</td> </td>
<td width="50%"> <td width="50%">
<a href="#new-to-git-and-gitlab"><strong>New to Git and GitLab?</strong> <i class="fa fa-gitlab" aria-hidden="true"></i></a> <a href="#new-to-git-and-gitlab"><strong>New to Git and GitLab?</strong></a>
<br/> <br/>
We have resources to get you started. We have resources to get you started.
</td> </td>
</tr> </tr>
<tr> <tr>
<td width="50%"> <td width="50%">
<a href="#building-an-integration-with-gitlab"><strong>Building an integration with GitLab?</strong> <i class="fa fa-gitlab" aria-hidden="true"></i></a> <a href="#building-an-integration-with-gitlab"><strong>Building an integration with GitLab?</strong></a>
<br/> <br/>
Consult our our automation and integration documentation. Consult our our automation and integration documentation.
</td> </td>
<td width="50%"> <td width="50%">
<a href="#coming-to-gitlab-from-another-platform"><strong>Coming to GitLab from another platform?</strong> <i class="fa fa-gitlab" aria-hidden="true"></i></a> <a href="#coming-to-gitlab-from-another-platform"><strong>Coming to GitLab from another platform?</strong></a>
<br/> <br/>
Consult our handy guides. Consult our handy guides.
</td> </td>
...@@ -55,9 +55,6 @@ No matter how you use GitLab, we have documentation for you. ...@@ -55,9 +55,6 @@ No matter how you use GitLab, we have documentation for you.
</tbody> </tbody>
</table> </table>
TIP: **Tip:**
You can also find documentation topics arranged by [DevOps Lifecycle stage](#complete-devops-with-gitlab).
## Popular Documentation ## Popular Documentation
Have a look at some of our most popular documentation resources: Have a look at some of our most popular documentation resources:
...@@ -80,7 +77,7 @@ making the software lifecycle faster and radically improving the speed of busine ...@@ -80,7 +77,7 @@ making the software lifecycle faster and radically improving the speed of busine
GitLab provides solutions for [all the stages of the DevOps lifecycle](https://about.gitlab.com/stages-devops-lifecycle/): GitLab provides solutions for [all the stages of the DevOps lifecycle](https://about.gitlab.com/stages-devops-lifecycle/):
<img class="image-noshadow" src="img/devops_lifecycle.png" alt="DevOps Lifecycle"> <img class="image-noshadow" src="img/devops-stages.png" alt="DevOps Stages">
The following sections provide links to documentation for each DevOps stage: The following sections provide links to documentation for each DevOps stage:
...@@ -139,7 +136,7 @@ The following documentation relates to the DevOps **Plan** stage: ...@@ -139,7 +136,7 @@ The following documentation relates to the DevOps **Plan** stage:
| [Milestones](user/project/milestones/index.md) | Set milestones for delivery of issues and merge requests, with optional due date. | | [Milestones](user/project/milestones/index.md) | Set milestones for delivery of issues and merge requests, with optional due date. |
| [Project Issue Board](user/project/issue_board.md) | Display issues on a Scrum or Kanban board. | | [Project Issue Board](user/project/issue_board.md) | Display issues on a Scrum or Kanban board. |
| [Time Tracking](workflow/time_tracking.md) | Track time spent on issues and merge requests. | | [Time Tracking](workflow/time_tracking.md) | Track time spent on issues and merge requests. |
| [Todos](workflow/todos.md) | Keep track of work requiring attention with a chronological list displayed on a simple dashboard. | | [Todos](workflow/todos.md) | Keep track of work requiring attention with a chronological list displayed on a simple dashboard. |
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -149,7 +146,7 @@ The following documentation relates to the DevOps **Plan** stage: ...@@ -149,7 +146,7 @@ The following documentation relates to the DevOps **Plan** stage:
### Create ### Create
Consolidate source code into a single [DVCS](https://en.wikipedia.org/wiki/Distributed_version_control) Consolidate source code into a single [distributed version control system](https://en.wikipedia.org/wiki/Distributed_version_control)
that’s easily managed and controlled without disrupting your workflow. that’s easily managed and controlled without disrupting your workflow.
GitLab’s Git repositories come complete with branching tools and access GitLab’s Git repositories come complete with branching tools and access
...@@ -158,20 +155,18 @@ on projects and code. ...@@ -158,20 +155,18 @@ on projects and code.
The following documentation relates to the DevOps **Create** stage: The following documentation relates to the DevOps **Create** stage:
| Projects and Groups Topics | Description | #### Projects and Groups
|:---------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------|
| [Create a project](gitlab-basics/create-project.md) | Create a project. | | Create Topics - Projects and Groups | Description |
| [Fork a project](gitlab-basics/fork-project.md) | Duplicate a project. | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------|
| [GitLab Pages](user/project/pages/index.md) | Build, test, and deploy your static website with GitLab Pages. | | [Create](gitlab-basics/create-project.md) and [fork](gitlab-basics/fork-project.md) projects, and [import and export projects between instances](user/project/settings/import_export.md) | Create, duplicate, and move projects. |
| [Groups](user/group/index.md) and [Subgroups](user/group/subgroups/index.md) | Organize your projects in groups. | | [GitLab Pages](user/project/pages/index.md) | Build, test, and deploy your static website with GitLab Pages. |
| [Importing and exporting projects between instances](user/project/settings/import_export.md) | Move projects. | | [Groups](user/group/index.md) and [Subgroups](user/group/subgroups/index.md) | Organize your projects in groups. |
| [Project access](public_access/public_access.md) | Set up your project's visibility to public, internal, or private. | | [Projects](user/project/index.md), including [project access](public_access/public_access.md) and [settings](user/project/settings/index.md) | Host source code, and control your project's visibility and set configuration. |
| [Project settings](user/project/settings/index.md) | Project configuration. | | [Search through GitLab](user/search/index.md) | Search for issues, merge requests, projects, groups, and todos. |
| [Projects](user/project/index.md) | Host source code and bring many parts of GitLab together. | | [Snippets](user/snippets.md) | Snippets allow you to create little bits of code. |
| [Search through GitLab](user/search/index.md) | Search for issues, merge requests, projects, groups, todos, and issues in Issue Boards. | | [Web IDE](user/project/web_ide/index.md) | Edit files within GitLab's user interface. |
| [Snippets](user/snippets.md) | Snippets allow you to create little bits of code. | | [Wikis](user/project/wiki/index.md) | Enhance your repository documentation with built-in wikis. |
| [Web IDE](user/project/web_ide/index.md) | Edit files within GitLab's user interface. |
| [Wikis](user/project/wiki/index.md) | Enhance your repository documentation with built-in wikis. |
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -181,19 +176,20 @@ The following documentation relates to the DevOps **Create** stage: ...@@ -181,19 +176,20 @@ The following documentation relates to the DevOps **Create** stage:
--- ---
| Repositories Topics | Description | #### Repositories
|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------|
| [Branches](user/project/repository/branches/index.md) and the [default branch](user/project/repository/branches/index.md#default-branch) | How to use branches in GitLab. | | Create Topics - Repositories | Description |
| [Commits](user/project/repository/index.md#commits) and [signing commits](user/project/repository/gpg_signed_commits/index.md) | Work with commits, and use GPG to sign your commits. | |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------|
| [Create a branch](user/project/repository/web_editor.md#create-a-new-branch) | Create branches within GitLab's user interface. | | [Branches](user/project/repository/branches/index.md) and the [default branch](user/project/repository/branches/index.md#default-branch) | How to use branches in GitLab. |
| [Create a file](user/project/repository/web_editor.md#create-a-file), [upload a file](user/project/repository/web_editor.md#upload-a-file), and [create a directory](user/project/repository/web_editor.md#create-a-directory) | Create and upload files, and create directories within GitLab. | | [Commits](user/project/repository/index.md#commits) and [signing commits](user/project/repository/gpg_signed_commits/index.md) | Work with commits, and use GPG to sign your commits. |
| [Delete merged branches](user/project/repository/branches/index.md#delete-merged-branches) | Bulk delete branches after their changes are merged. | | [Create branches](user/project/repository/web_editor.md#create-a-new-branch), [create](user/project/repository/web_editor.md#create-a-file) and [upload](user/project/repository/web_editor.md#upload-a-file) files, and [create directories](user/project/repository/web_editor.md#create-a-directory) | Create branches, create and upload files, and create directories within GitLab. |
| [File templates](user/project/repository/web_editor.md#template-dropdowns) | File templates for common files. | | [Delete merged branches](user/project/repository/branches/index.md#delete-merged-branches) | Bulk delete branches after their changes are merged. |
| [Files](user/project/repository/index.md#files) | Files management. | | [File templates](user/project/repository/web_editor.md#template-dropdowns) | File templates for common files. |
| [Jupyter Notebook files](user/project/repository/index.md#jupyter-notebook-files) | GitLab's support for `.ipynb` files. | | [Files](user/project/repository/index.md#files) | Files management. |
| [Protected branches](user/project/protected_branches.md) | Use protected branches. | | [Jupyter Notebook files](user/project/repository/index.md#jupyter-notebook-files) | GitLab's support for `.ipynb` files. |
| [Repositories](user/project/repository/index.md) | Manage source code repositories in GitLab's user interface. | | [Protected branches](user/project/protected_branches.md) | Use protected branches. |
| [Start a merge request](user/project/repository/web_editor.md#tips) | Start merge request when commiting via GitLab's user interface. | | [Repositories](user/project/repository/index.md) | Manage source code repositories in GitLab's user interface. |
| [Start a merge request](user/project/repository/web_editor.md#tips) | Start merge request when committing via GitLab's user interface. |
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -203,13 +199,15 @@ The following documentation relates to the DevOps **Create** stage: ...@@ -203,13 +199,15 @@ The following documentation relates to the DevOps **Create** stage:
--- ---
| Merge Requests Topics | Description | #### Merge Requests
|:------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
| [Checking out merge requests locally](user/project/merge_requests/index.md#checkout-merge-requests-locally) | Tips for working with merge requests locally. | | Create Topics - Merge Requests | Description |
| [Cherry-picking](user/project/merge_requests/cherry_pick_changes.md) | Use GitLab for cherry-picking changes. | |:------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------|
| [Merge request discussion resolution](user/discussions/index.md#moving-a-single-discussion-to-a-new-issue) | Resolve discussions, move discussions in a merge request to an issue, only allow merge requests to be merged if all discussions are resolved. | | [Checking out merge requests locally](user/project/merge_requests/index.md#checkout-merge-requests-locally) | Tips for working with merge requests locally. |
| [Merge requests](user/project/merge_requests/index.md) | Merge request management. | | [Cherry-picking](user/project/merge_requests/cherry_pick_changes.md) | Use GitLab for cherry-picking changes. |
| [Work In Progress "WIP" merge requests](user/project/merge_requests/work_in_progress_merge_requests.md) | Prevent merges of work-in-progress merge requests. | | [Merge request discussion resolution](user/discussions/index.md#moving-a-single-discussion-to-a-new-issue) | Resolve discussions, move discussions in a merge request to an issue, and only allow merge requests to be merged if all discussions are resolved. |
| [Merge requests](user/project/merge_requests/index.md) | Merge request management. |
| [Work In Progress "WIP" merge requests](user/project/merge_requests/work_in_progress_merge_requests.md) | Prevent merges of work-in-progress merge requests. |
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -219,9 +217,13 @@ The following documentation relates to the DevOps **Create** stage: ...@@ -219,9 +217,13 @@ The following documentation relates to the DevOps **Create** stage:
--- ---
| Integrations Topics | Description | #### Integration and Automation
| Create Topics - Integration and Automation | Description |
|:------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------| |:------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------|
| [GitLan API](api/README.md) | Integrate GitLab via a simple and powerful API. |
| [GitLab Integration](integration/README.md) | Integrate with multiple third-party services with GitLab to allow external issue trackers and external authentication. | | [GitLab Integration](integration/README.md) | Integrate with multiple third-party services with GitLab to allow external issue trackers and external authentication. |
| [GitLab Webhooks](user/project/integrations/webhooks.md) | Let GitLab notify you when new code has been pushed to your project. |
| [Project Services](user/project/integrations/project_services.md) | Integrate a project with external services, such as CI and chat. | | [Project Services](user/project/integrations/project_services.md) | Integrate a project with external services, such as CI and chat. |
| [Trello Power-Up](integration/trello_power_up.md) | Integrate with GitLab's Trello Power-Up. | | [Trello Power-Up](integration/trello_power_up.md) | Integrate with GitLab's Trello Power-Up. |
...@@ -231,23 +233,10 @@ The following documentation relates to the DevOps **Create** stage: ...@@ -231,23 +233,10 @@ The following documentation relates to the DevOps **Create** stage:
</a> </a>
</div> </div>
---
| Automation Topics | Description |
|:---------------------------------------------------------|:---------------------------------------------------------------------|
| [API](api/README.md) | Automate GitLab via a simple and powerful API. |
| [GitLab Webhooks](user/project/integrations/webhooks.md) | Let GitLab notify you when new code has been pushed to your project. |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### Verify ### Verify
Spot errors sooner, improve security and shorten feedback cycles with built-in Spot errors sooner, improve security and shorten feedback cycles with built-in
static code analysis, code testing, code quality, dependency checking and Review static code analysis, code testing, code quality, dependency checking, and Review
Apps. Customize your approval workflow controls, automatically test the quality Apps. Customize your approval workflow controls, automatically test the quality
of your code, and spin up a staging environment for every code change. of your code, and spin up a staging environment for every code change.
...@@ -256,12 +245,12 @@ scales to run your tests faster. ...@@ -256,12 +245,12 @@ scales to run your tests faster.
The following documentation relates to the DevOps **Verify** stage: The following documentation relates to the DevOps **Verify** stage:
| Verify Topics | Description | | Verify Topics | Description |
|:---------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------| |:---------------------------------------------------|:-----------------------------------------------------------------------------|
| [GitLab CI/CD](ci/README.md) | Explore the features and capabilities of Continuous Integration, Continuous Delivery, and Continuous Deployment with GitLab. | | [GitLab CI/CD](ci/README.md) | Explore the features and capabilities of Continuous Integration with GitLab. |
| [JUnit test reports](ci/junit_test_reports.md) | Display JUnit test reports on merge requests. | | [JUnit test reports](ci/junit_test_reports.md) | Display JUnit test reports on merge requests. |
| [Pipeline Graphs](ci/pipelines.md#pipeline-graphs) | Visualize builds. | | [Pipeline Graphs](ci/pipelines.md#pipeline-graphs) | Visualize builds. |
| [Review Apps](ci/review_apps/index.md) | Preview changes to your app right from a merge request. | | [Review Apps](ci/review_apps/index.md) | Preview changes to your application right from a merge request. |
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -297,8 +286,9 @@ The following documentation relates to the DevOps **Release** stage: ...@@ -297,8 +286,9 @@ The following documentation relates to the DevOps **Release** stage:
| Release Topics | Description | | Release Topics | Description |
|:------------------------------------------------------------|:---------------------------------------------------------------------------------------------| |:------------------------------------------------------------|:---------------------------------------------------------------------------------------------|
| [Auto Deploy](topics/autodevops/index.md#auto-deploy) | Configure GitLab CI for the deployment of your application. | | [Auto Deploy](topics/autodevops/index.md#auto-deploy) | Configure GitLab for the deployment of your application. |
| [Environments and deployments](ci/environments.md) | With environments, you can control the continuous deployment of your software within GitLab. | | [Environments and deployments](ci/environments.md) | With environments, you can control the continuous deployment of your software within GitLab. |
| [GitLab CI/CD](ci/README.md) | Explore the features and capabilities of Continuous Deployment and Delivery with GitLab. |
| [GitLab Pages](user/project/pages/index.md) | Build, test, and deploy a static site directly from GitLab. | | [GitLab Pages](user/project/pages/index.md) | Build, test, and deploy a static site directly from GitLab. |
| [Protected Runners](ci/runners/README.md#protected-runners) | Select Runners to only pick jobs for protected branches and tags. | | [Protected Runners](ci/runners/README.md#protected-runners) | Select Runners to only pick jobs for protected branches and tags. |
| [Scheduled Pipelines](user/project/pipelines/schedules.md) | Execute pipelines on a schedule. | | [Scheduled Pipelines](user/project/pipelines/schedules.md) | Execute pipelines on a schedule. |
...@@ -323,9 +313,9 @@ The following documentation relates to the DevOps **Configure** stage: ...@@ -323,9 +313,9 @@ The following documentation relates to the DevOps **Configure** stage:
| [Easy creation of Kubernetes clusters on GKE](user/project/clusters/index.md#adding-and-creating-a-new-gke-cluster-via-gitlab) | Use Google Kubernetes Engine and GitLab. | | [Easy creation of Kubernetes clusters on GKE](user/project/clusters/index.md#adding-and-creating-a-new-gke-cluster-via-gitlab) | Use Google Kubernetes Engine and GitLab. |
| [Executable Runbooks](user/project/clusters/runbooks/index.md) | Documented procedures that explain how to carry out particular processes. | | [Executable Runbooks](user/project/clusters/runbooks/index.md) | Documented procedures that explain how to carry out particular processes. |
| [Installing Applications](user/project/clusters/index.md#installing-applications) | Deploy Helm, Ingress, and Prometheus on Kubernetes. | | [Installing Applications](user/project/clusters/index.md#installing-applications) | Deploy Helm, Ingress, and Prometheus on Kubernetes. |
| [Mattermost slash commands](user/project/integrations/mattermost_slash_commands.md) | | | [Mattermost slash commands](user/project/integrations/mattermost_slash_commands.md) | Enable and use slash commands from within Mattermost. |
| [Protected variables](ci/variables/README.md#protected-variables) | Restrict variables to protected branches and tags. | | [Protected variables](ci/variables/README.md#protected-variables) | Restrict variables to protected branches and tags. |
| [Slack slash commands](user/project/integrations/slack_slash_commands.md) | | | [Slack slash commands](user/project/integrations/slack_slash_commands.md) | Enable and use slash commands from within Slack. |
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -335,10 +325,9 @@ The following documentation relates to the DevOps **Configure** stage: ...@@ -335,10 +325,9 @@ The following documentation relates to the DevOps **Configure** stage:
### Monitor ### Monitor
Measure how long it takes to go from planning to monitoring and ensure your Ensure your applications are always responsive and available.
applications are always responsive and available.
GitLab collects and displays performance metrics for deployed apps using Prometheus so you can know in an GitLab collects and displays performance metrics for deployed applications so you can know in an
instant how code changes impact your production environment. instant how code changes impact your production environment.
The following documentation relates to the DevOps **Monitor** stage: The following documentation relates to the DevOps **Monitor** stage:
...@@ -359,24 +348,23 @@ The following documentation relates to the DevOps **Monitor** stage: ...@@ -359,24 +348,23 @@ The following documentation relates to the DevOps **Monitor** stage:
### Secure ### Secure
GitLab can help you secure your applications from within your development lifecycle.
The following documentation relates to the DevOps **Secure** stage: The following documentation relates to the DevOps **Secure** stage:
| Monitor Topics | Description | | Monitor Topics | Description |
|:--------------------------------------------------------|:-----------------------------------------------------------| |:--------------------------------------------------------|:-----------------------------------------------------------|
| [Container Scanning](ci/examples/container_scanning.md) | Use Clair to scan docker images for known vulnerabilities. | | [Container Scanning](ci/examples/container_scanning.md) | Use Clair to scan docker images for known vulnerabilities. |
## New to Git and GitLab? ## Subscribe to GitLab
Working with new systems can be daunting. There are two ways to use GitLab:
We have the following documentation to rapidly uplift your GitLab knowledge: - [GitLab self-managed](#gitlab-self-managed): Install, administer, and maintain your own GitLab instance.
- [GitLab.com](#gitlab-com): GitLab's SaaS offering. You don't need to install anything to use GitLab.com,
you only need to [sign up](https://gitlab.com/users/sign_in) and start using GitLab straight away.
- [GitLab Basics](gitlab-basics/README.md): Start working on your command line and on GitLab. The following sections outline tiers and features within GitLab self-managed and GitLab.com.
- [GitLab Workflow](workflow/README.md): Enhance your workflow with the best of GitLab Workflow.
- See also [GitLab Workflow - an overview](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/).
- [GitLab CI/CD quick start guide](ci/quick_start/README.md).
- [Auto DevOps](topics/autodevops/index.md).
- [GitLab Markdown](user/markdown.md): GitLab's advanced formatting system (GitLab Flavored Markdown).
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -384,15 +372,22 @@ We have the following documentation to rapidly uplift your GitLab knowledge: ...@@ -384,15 +372,22 @@ We have the following documentation to rapidly uplift your GitLab knowledge:
</a> </a>
</div> </div>
### User account ### GitLab self-managed
Learn more about GitLab account management: With GitLab self-managed, you deploy your own GitLab instance on-premises or on a private cloud of your choice.
GitLab self-managed is available for [free and with paid subscriptions](https://about.gitlab.com/pricing/#self-managed) in the following tiers:
| Tier | Includes |
|:---------|:-----------------------------------------------|
| Core | Core features. |
| Starter | Core and Starter features. |
| Premium | Core, Starter, and Premium features. |
| Ultimate | Core, Starter, Premium, and Ultimate features. |
To learn more about GitLab:
- [User account](user/profile/index.md): Manage your account - Features at each tier, see our [Feature Comparison](https://about.gitlab.com/pricing/self-managed/feature-comparison/) for self-managed.
- [Authentication](topics/authentication/index.md): Account security with two-factor authentication, set up your ssh keys and deploy - Subscriptions and licensing, please refer to the [GitLab Product Marketing Handbook](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers).
keys for secure access to your projects.
- [Profile settings](user/profile/index.md#profile-settings): Manage your profile settings, two factor authentication and more.
- [User permissions](user/permissions.md): Learn what each role in a project (external/guest/reporter/developer/maintainer/owner) can do.
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -400,13 +395,30 @@ Learn more about GitLab account management: ...@@ -400,13 +395,30 @@ Learn more about GitLab account management:
</a> </a>
</div> </div>
### Git and GitLab ### GitLab.com
Learn more about using Git, and using Git with GitLab: GitLab.com is hosted, managed, and administered by GitLab, Inc., with
[free and paid subscriptions](https://about.gitlab.com/pricing/) for individuals
and teams in the following tiers:
| Tier | Includes same features available in |
|:-------|:----------------------------------------------------|
| Free | [Core](#gitlab-self-managed) self-managed tier. |
| Bronze | [Starter](#gitlab-self-managed) self-managed tier. |
| Silver | [Premium](#gitlab-self-managed) self-managed tier. |
| Gold | [Ultimate](#gitlab-self-managed) self-managed tier. |
GitLab.com subscriptions grant access
to the same features available in GitLab self-managed, **except
[administration](administration/index.md) tools and settings**:
TIP: **Tip:**
To support the open source community and encourage the development of open source projects, GitLab grants access to **Gold** features for all GitLab.com **public** projects, regardless of the subscription.
To learn more about GitLab:
- [Git](topics/git/index.md): Getting started with Git, branching strategies, Git LFS, advanced use. - Features at each tier, see our [Feature Comparison](https://about.gitlab.com/pricing/gitlab-com/feature-comparison/) for GitLab.com.
- [Git cheatsheet](https://about.gitlab.com/images/press/git-cheat-sheet.pdf): Download a PDF describing the most used Git operations. - Subscriptions and licensing, please refer to the [GitLab Product Marketing Handbook](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers).
- [GitLab Flow](workflow/gitlab_flow.md): explore the best of Git with the GitLab Flow strategy.
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -414,13 +426,19 @@ Learn more about using Git, and using Git with GitLab: ...@@ -414,13 +426,19 @@ Learn more about using Git, and using Git with GitLab:
</a> </a>
</div> </div>
### GitLab subscriptions ## New to Git and GitLab?
You have two options to use GitLab: Working with new systems can be daunting.
- [GitLab self-managed](#gitlab-self-managed): Install, administer, and maintain your own GitLab instance. We have the following documentation to rapidly uplift your GitLab knowledge:
- [GitLab.com](#gitlab-com): GitLab's SaaS offering. You don't need to install anything to use GitLab.com,
you only need to [sign up](https://gitlab.com/users/sign_in) and start using GitLab straight away. | Topic | Description |
|:-----------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------|
| [GitLab Basics](gitlab-basics/README.md) | Start working on the command line and with GitLab. |
| [GitLab Workflow](workflow/README.md) and [overview](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/) | Enhance your workflow with the best of GitLab Workflow. |
| [Get started with GitLab CI/CD](ci/quick_start/README.md) | Quickly implement GitLab CI/CD. |
| [Auto DevOps](topics/autodevops/index.md) | Learn more about GitLab's Auto DevOps. |
| [GitLab Markdown](user/markdown.md) | GitLab's advanced formatting system (GitLab Flavored Markdown) |
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -428,14 +446,16 @@ You have two options to use GitLab: ...@@ -428,14 +446,16 @@ You have two options to use GitLab:
</a> </a>
</div> </div>
### GitLab self-managed ### User account
With GitLab self-managed, you deploy your own GitLab instance on-premises or on a private cloud of your choice. Learn more about GitLab account management:
GitLab self-managed is available for [free and with paid subscriptions](https://about.gitlab.com/pricing/): Core, Starter, Premium, and Ultimate.
Every feature available in Core is also available in Starter, Premium, and Ultimate. | Topic | Description |
Starter features are also available in Premium and Ultimate, and Premium features are also |:-----------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------|
available in Ultimate. | [User account](user/profile/index.md) | Manage your account. |
| [Authentication](topics/authentication/index.md) | Account security with two-factor authentication, set up your ssh keys, and deploy keys for secure access to your projects. |
| [Profile settings](user/profile/index.md#profile-settings) | Manage your profile settings, two factor authentication, and more. |
| [User permissions](user/permissions.md) | Learn what each role in a project can do. |
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -443,27 +463,15 @@ available in Ultimate. ...@@ -443,27 +463,15 @@ available in Ultimate.
</a> </a>
</div> </div>
### GitLab.com ### Git and GitLab
GitLab.com is hosted, managed, and administered by GitLab, Inc., with
[free and paid subscriptions](https://about.gitlab.com/gitlab-com/) for individuals
and teams: Free, Bronze, Silver, and Gold.
GitLab.com subscriptions grants access
to the same features available in GitLab self-managed, **except
[administration](administration/index.md) tools and settings**:
- GitLab.com Free includes the same features available in Core.
- GitLab.com Bronze includes the same features available in GitLab Starter.
- GitLab.com Silver includes the same features available in GitLab Premium.
- GitLab.com Gold includes the same features available in GitLab Ultimate.
For supporting the open source community and encouraging the development of Learn more about using Git, and using Git with GitLab:
open source projects, GitLab grants access to **Gold** features
for all GitLab.com **public** projects, regardless of the subscription.
To know more about GitLab subscriptions and licensing, please refer to the | Topic | Description |
[GitLab Product Marketing Handbook](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers). |:----------------------------------------------------------------------------|:---------------------------------------------------------------------------|
| [Git](topics/git/index.md) | Getting started with Git, branching strategies, Git LFS, and advanced use. |
| [Git cheatsheet](https://about.gitlab.com/images/press/git-cheat-sheet.pdf) | Download a PDF describing the most used Git operations. |
| [GitLab Flow](workflow/gitlab_flow.md) | Explore the best of Git with the GitLab Flow strategy. |
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -475,9 +483,10 @@ To know more about GitLab subscriptions and licensing, please refer to the ...@@ -475,9 +483,10 @@ To know more about GitLab subscriptions and licensing, please refer to the
If you are coming to GitLab from another platform, you'll find the following information useful: If you are coming to GitLab from another platform, you'll find the following information useful:
- [Importing to GitLab](user/project/import/index.md): Import your projects from GitHub, | Topic | Description |
Bitbucket, GitLab.com, FogBugz and SVN into GitLab. |:---------------------------------------------------------------|:---------------------------------------------------------------------------------------|
- [Migrating from SVN](workflow/importing/migrating_from_svn.md): Convert a SVN repository to Git and GitLab. | [Importing to GitLab](user/project/import/index.md) | Import your projects from GitHub, Bitbucket, GitLab.com, FogBugz, and SVN into GitLab. |
| [Migrating from SVN](workflow/importing/migrating_from_svn.md) | Convert a SVN repository to Git and GitLab. |
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -487,10 +496,12 @@ If you are coming to GitLab from another platform, you'll find the following inf ...@@ -487,10 +496,12 @@ If you are coming to GitLab from another platform, you'll find the following inf
## Building an integration with GitLab ## Building an integration with GitLab
There are many ways to integration with GitLab, including: There are many ways to integrate with GitLab, including:
- Our [API](api/README.md). | Topic | Description |
- Other [integrations](#integrations) and [automation](#automation). |:-----------------------------------------------------------|:------------------------------------------------|
| [GitLab API](api/README.md) | Integrate GitLab via a simple and powerful API. |
| [Integrations and automation](#integration-and-automation) | All GitLab integration and automation options. |
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -502,11 +513,14 @@ There are many ways to integration with GitLab, including: ...@@ -502,11 +513,14 @@ There are many ways to integration with GitLab, including:
GitLab Community Edition is [open source](https://gitlab.com/gitlab-org/gitlab-ce/) GitLab Community Edition is [open source](https://gitlab.com/gitlab-org/gitlab-ce/)
and GitLab Enterprise Edition is [open-core](https://gitlab.com/gitlab-org/gitlab-ee/). and GitLab Enterprise Edition is [open-core](https://gitlab.com/gitlab-org/gitlab-ee/).
Learn how to contribute to GitLab:
- [Development](development/README.md): All styleguides and explanations how to contribute. Learn how to contribute to GitLab with the following resources:
- [Legal](legal/README.md): Contributor license agreements.
- [Writing documentation](development/documentation/index.md): Contributing to GitLab Docs. | Topic | Description |
|:------------------------------------------------------------|:-----------------------------------------|
| [Development](development/README.md) | How to contribute to GitLab development. |
| [Legal](legal/README.md) | Contributor license agreements. |
| [Writing documentation](development/documentation/index.md) | How to contribute to GitLab Docs. |
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7