Skip to content

G
gitlab-ce
Commit ef47c7f0 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis
Browse files
Options

Revert "Merge branch 'docs/split-front-page' into 'master'" 

This reverts merge request
https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/21946
parent 07d10976
Show whitespace changes
Inline Side-by-side
Showing with 168 additions and 458 deletions
doc/README.md
View file @ ef47c7f0
...@@ -5,270 +5,135 @@ description: 'Learn how to use and administer GitLab, the most scalable Git-base ...@@ -5,270 +5,135 @@ description: 'Learn how to use and administer GitLab, the most scalable Git-base
# GitLab Documentation # GitLab Documentation
Welcome to [GitLab](https://about.gitlab.com/) Documentation. Welcome to [GitLab](https://about.gitlab.com/), a Git-based fully featured
platform for software development!
Here you can access the complete documentation for GitLab, the single application for the
[entire DevOps lifecycle](#complete-devops-with-gitlab).
## Overview
No matter how you use GitLab, we have documentation for you.
<table>
<tbody>
<tr>
<td width="50%">
<a href="user/index.md"><strong>User documentation</strong></a>
<br/>
Discover features and concepts for GitLab users.
</td>
<td width="50%">
<a href="administration/index.md"><strong>Administrator documentation</strong></a>
<br/>
Everything GitLab administrators need to know.
</td>
</tr>
<tr>
<td width="50%">
<a href="#contributing-to-gitlab"><strong>Contributing to GitLab</strong></a>
<br/>
At GitLab, everyone can contribute!
</td>
<td width="50%">
<a href="#new-to-git-and-gitlab"><strong>New to Git and GitLab?</strong></a>
<br/>
We have resources to get you started.
</td>
</tr>
<tr>
<td width="50%">
<a href="#building-an-integration-with-gitlab"><strong>Building an integration with GitLab?</strong></a>
<br/>
Consult our automation and integration documentation.
</td>
<td width="50%">
<a href="#coming-to-gitlab-from-another-platform"><strong>Coming to GitLab from another platform?</strong></a>
<br/>
Consult our handy guides.
</td>
</tr>
<tr>
<td width="50%">
<a href="https://about.gitlab.com/install/"><strong>Install GitLab</strong></a>
<br/>
Installation options for different platforms.
</td>
<td width="50%">
<a href="#subscribe-to-gitlab"><strong>Subscribe to GitLab</strong></a>
<br/>
Get access to more features.
</td>
</tr>
</tbody>
</table>
## Popular Documentation
Have a look at some of our most popular documentation resources:
| Popular Topic | Description |
|:----------------------------------------------------------------|:-----------------------------------------------------------------|
| [Configuring `.gitlab-ci.yml`](ci/yaml/README.md) | Complete syntax documentation for configuring your CI pipelines. |
| [GitLab CI/CD examples](ci/examples/README.md) | Get up to speed quickly with common CI/CD scenarios. |
| [GitLab Container Registry](user/project/container_registry.md) | Host containers within GitLab. |
| [GitLab Pages](user/project/pages/index.md) | Host static websites for your projects with GitLab. |
| [Kubernetes integration](user/project/clusters/index.md) | Use GitLab with Kubernetes. |
| [SSH authentication](ssh/README.md) | Secure your network communications. |
| [Using Docker images](ci/docker/using_docker_images.md) | Build and test your applications with Docker. |
## The entire DevOps Lifecycle
GitLab is the first single application for software development, security, GitLab offers the most scalable Git-based fully integrated platform for
and operations that enables [Concurrent DevOps](https://about.gitlab.com/concurrent-devops/), software development, with flexible products and subscriptions.
making the software lifecycle faster and radically improving the speed of business. To understand what features you have access to, check the [GitLab subscriptions](#gitlab-subscriptions) below.
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-stages.png" alt="DevOps Stages">
The following sections provide links to documentation for each DevOps stage:
| DevOps Stage | Documentation for |
|:------------------------|:------------------------------------------------------------|
| [Manage](#manage) | Statistics and analytics features. |
| [Plan](#plan) | Project planning and management features. |
| [Create](#create) | Source code and data creation and management features. |
| [Verify](#verify) | Testing, code quality, and continuous integration features. |
| [Package](#package) | Docker container registry. |
| [Release](#release) | Application release and delivery features. |
| [Configure](#configure) | Application and infrastructure configuration tools. |
| [Monitor](#monitor) | Application monitoring and metrics features. |
| [Secure](#secure) | Security capability feature. |
<div align="right"> **Shortcuts to GitLab's most visited docs:**
<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>
### Manage | General documentation | GitLab CI/CD docs |
| :----- | :----- |
| [User documentation](user/index.md) | [GitLab CI/CD quick start guide](ci/quick_start/README.md) |
| [Administrator documentation](administration/index.md) | [GitLab CI/CD examples](ci/examples/README.md) |
| [Contributor documentation](#contributor-documentation) | [Configuring `.gitlab-ci.yml`](ci/yaml/README.md) |
| [Getting started with GitLab](#getting-started-with-gitlab) | [Using Docker images](ci/docker/using_docker_images.md) |
| [API](api/README.md) | [Auto DevOps](topics/autodevops/index.md) |
| [SSH authentication](ssh/README.md) | [Kubernetes integration](user/project/clusters/index.md)|
| [GitLab Pages](user/project/pages/index.md) | [GitLab Container Registry](user/project/container_registry.md) |
GitLab provides statistics and insight into ways you can maximize the value of GitLab in your organization. ## Complete DevOps with GitLab
The following documentation relates to the DevOps **Manage** stage: GitLab is the first single application for software development, security,
and operations that enables Concurrent DevOps, making the software lifecycle
| Manage Topics | Description | three times faster and radically improving the speed of business. GitLab
|:----------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| provides solutions for all the stages of the DevOps lifecycle:
| [Authentication and Authorization](administration/auth/README.md) **[CORE ONLY]** | Supported authentication and authorization providers. | [plan](#plan), [create](#create), [verify](#verify), [package](#package),
| [GitLab Cycle Analytics](user/project/cycle_analytics.md) | Measure the time it takes to go from an [idea to production](https://about.gitlab.com/2016/08/05/continuous-integration-delivery-and-deployment-with-gitlab/#from-idea-to-production-with-gitlab) for each project you have. | [release](#release), [configure](#configure), [monitor](#monitor).
| [Instance Statistics](user/instance_statistics/index.md) | Discover statistics on how many GitLab features you use and user activity. |
<div align="right"> <img class="image-noshadow" src="img/devops_lifecycle.png" alt="DevOps Lifecycle">
<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>
### Plan ### Plan
Whether you use Waterfall, Agile, or Conversational Development, GitLab streamlines your collaborative workflows. Whether you use Waterfall, Agile, or Conversational Development,
GitLab streamlines your collaborative workflows. Visualize, prioritize,
Visualize, prioritize, coordinate, and track your progress your way with GitLab’s flexible project coordinate, and track your progress your way with GitLab’s flexible project
management tools. management tools.
The following documentation relates to the DevOps **Plan** stage: - Chat operations
- [Mattermost slash commands](user/project/integrations/mattermost_slash_commands.md)
| Plan Topics | Description | - [Slack slash commands](user/project/integrations/slack_slash_commands.md)
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------| - [Discussions](user/discussions/index.md): Threads, comments, and resolvable discussions in issues, commits, and merge requests.
| [Discussions](user/discussions/index.md) | Threads, comments, and resolvable discussions in issues, commits, and merge requests. | - [Issues](user/project/issues/index.md)
| [Due Dates](user/project/issues/due_dates.md) | Keep track of issue deadlines. | - [Project Issue Board](user/project/issue_board.md)
| [Quick Actions](user/project/quick_actions.md) | Shortcuts for common actions on issues or merge requests, replacing the need to click buttons or use dropdowns in GitLab's UI. | - [Issues and merge requests templates](user/project/description_templates.md): Create templates for submitting new issues and merge requests.
| [Issues](user/project/issues/index.md), including [confidential issues](user/project/issues/confidential_issues.md), [issue and merge request templates](user/project/description_templates.md), and [moving issues](user/project/issues/moving_issues.md) | Project issues, restricting access to issues, create templates for submitting new issues and merge requests, and moving issues between projects. | - [Labels](user/project/labels.md): Categorize your issues or merge requests based on descriptive titles.
| [Labels](user/project/labels.md) | Categorize issues or merge requests with descriptive labels. | - [Milestones](user/project/milestones/index.md): Organize issues and merge requests into a cohesive group, optionally setting a due date.
| [Milestones](user/project/milestones/index.md) | Set milestones for delivery of issues and merge requests, with optional due date. | - [Todos](workflow/todos.md): A chronological list of to-dos that are waiting for your input, all in a simple dashboard.
| [Project Issue Board](user/project/issue_board.md) | Display issues on a Scrum or Kanban board. | - [GitLab Quick Actions](user/project/quick_actions.md): Textual shortcuts for common actions on issues or merge requests that are usually done by clicking buttons or dropdowns in GitLab's UI.
| [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. | #### Migrate and import your projects from other platforms
<div align="right"> - [Importing to GitLab](user/project/import/index.md): Import your projects from GitHub, Bitbucket, GitLab.com, FogBugz and SVN into GitLab.
<a type="button" class="btn btn-default" href="#overview"> - [Migrating from SVN](workflow/importing/migrating_from_svn.md): Convert a SVN repository to Git and GitLab.
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### Create ### Create
Consolidate source code into a single [distributed version control system](https://en.wikipedia.org/wiki/Distributed_version_control) Consolidate source code into a single [DVCS](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
controls, providing a scalable, single source of truth for collaborating controls, providing a scalable, single source of truth for collaborating
on projects and code. on projects and code.
The following documentation relates to the DevOps **Create** stage: #### Projects and groups
#### Projects and Groups - [Projects](user/project/index.md):
- [Project settings](user/project/settings/index.md)
| Create Topics - Projects and Groups | Description | - [Create a project](gitlab-basics/create-project.md)
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------| - [Fork a project](gitlab-basics/fork-project.md)
| [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. | - [Importing and exporting projects between instances](user/project/settings/import_export.md).
| [GitLab Pages](user/project/pages/index.md) | Build, test, and deploy your static website with GitLab Pages. | - [Project access](public_access/public_access.md): Setting up your project's visibility to public, internal, or private.
| [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.
| [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. | - [Groups](user/group/index.md): Organize your projects in groups.
| [Search through GitLab](user/search/index.md) | Search for issues, merge requests, projects, groups, and todos. | - [Subgroups](user/group/subgroups/index.md)
| [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. | - [Wikis](user/project/wiki/index.md): Enhance your repository documentation with built-in wikis.
- [Web IDE](user/project/web_ide/index.md)
<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>
---
#### Repositories #### Repositories
| Create Topics - Repositories | Description | Manage your [repositories](user/project/repository/index.md) from the UI (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. | - [Files](user/project/repository/index.md#files)
| [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 file](user/project/repository/web_editor.md#create-a-file)
| [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. | - [Upload a file](user/project/repository/web_editor.md#upload-a-file)
| [Delete merged branches](user/project/repository/branches/index.md#delete-merged-branches) | Bulk delete branches after their changes are merged. | - [File templates](user/project/repository/web_editor.md#template-dropdowns)
| [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)
| [Files](user/project/repository/index.md#files) | Files management. | - [Create a directory](user/project/repository/web_editor.md#create-a-directory)
| [Jupyter Notebook files](user/project/repository/index.md#jupyter-notebook-files) | GitLab's support for `.ipynb` files. | - [Start a merge request](user/project/repository/web_editor.md#tips) (when committing via UI)
| [Protected branches](user/project/protected_branches.md) | Use protected branches. | - [Branches](user/project/repository/branches/index.md)
| [Repositories](user/project/repository/index.md) | Manage source code repositories in GitLab's user interface. | - [Default branch](user/project/repository/branches/index.md#default-branch)
| [Start a merge request](user/project/repository/web_editor.md#tips) | Start merge request when committing via GitLab's user interface. | - [Create a branch](user/project/repository/web_editor.md#create-a-new-branch)
- [Protected branches](user/project/protected_branches.md#protected-branches)
<div align="right"> - [Delete merged branches](user/project/repository/branches/index.md#delete-merged-branches)
<a type="button" class="btn btn-default" href="#overview"> - [Commits](user/project/repository/index.md#commits)
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i> - [Signing commits](user/project/repository/gpg_signed_commits/index.md): use GPG to sign your commits.
</a>
</div>
---
#### Merge Requests #### Merge Requests
| Create Topics - Merge Requests | Description | - [Merge Requests](user/project/merge_requests/index.md)
|:------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------| - [Work In Progress "WIP" Merge Requests](user/project/merge_requests/work_in_progress_merge_requests.md)
| [Checking out merge requests locally](user/project/merge_requests/index.md#checkout-merge-requests-locally) | Tips for working with merge requests locally. | - [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.
| [Cherry-picking](user/project/merge_requests/cherry_pick_changes.md) | Use GitLab for cherry-picking changes. | - [Checkout merge requests locally](user/project/merge_requests/index.md#checkout-merge-requests-locally)
| [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. | - [Cherry-pick](user/project/merge_requests/cherry_pick_changes.md)
| [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">
<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>
--- #### Integrations
#### Integration and Automation - [Project Services](user/project/integrations/project_services.md): Integrate a project with external services, such as CI and chat.
- [GitLab Integration](integration/README.md): Integrate with multiple third-party services with GitLab to allow external issue trackers and external authentication.
- [Trello Power-Up](integration/trello_power_up.md): Integrate with GitLab's Trello Power-Up
| Create Topics - Integration and Automation | Description | #### Automation
|:------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------|
| [GitLab 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 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. |
| [Trello Power-Up](integration/trello_power_up.md) | Integrate with GitLab's Trello Power-Up. |
<div align="right"> - [API](api/README.md): Automate GitLab via a simple and powerful API.
<a type="button" class="btn btn-default" href="#overview"> - [GitLab Webhooks](user/project/integrations/webhooks.md): Let GitLab notify you when new code has been pushed to your project.
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. GitLab
Continuous Integration is the most popular next generation testing system that
GitLab Continuous Integration is the most popular next generation testing system that
scales to run your tests faster. scales to run your tests faster.
The following documentation relates to the DevOps **Verify** stage: - [GitLab CI/CD](ci/README.md): Explore the features and capabilities of Continuous Integration, Continuous Delivery, and Continuous Deployment with GitLab.
- [Review Apps](ci/review_apps/index.md): Preview changes to your app right from a merge request.
| Verify Topics | Description | - [Pipeline Graphs](ci/pipelines.md#pipeline-graphs)
|:---------------------------------------------------|:-----------------------------------------------------------------------------| - [JUnit test reports](ci/junit_test_reports.md)
| [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. |
| [Pipeline Graphs](ci/pipelines.md#pipeline-graphs) | Visualize builds. |
| [Review Apps](ci/review_apps/index.md) | Preview changes to your application right from a merge request. |
<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>
### Package ### Package
...@@ -276,17 +141,7 @@ GitLab Container Registry gives you the enhanced security and access controls of ...@@ -276,17 +141,7 @@ GitLab Container Registry gives you the enhanced security and access controls of
custom Docker images without 3rd party add-ons. Easily upload and download images custom Docker images without 3rd party add-ons. Easily upload and download images
from GitLab CI/CD with full Git repository management integration. from GitLab CI/CD with full Git repository management integration.
The following documentation relates to the DevOps **Package** stage: - [GitLab Container Registry](user/project/container_registry.md): Learn how to use GitLab's built-in Container Registry.
| Package Topics | Description |
|:----------------------------------------------------------------|:-------------------------------------------------------|
| [GitLab Container Registry](user/project/container_registry.md) | Learn how to use GitLab's built-in Container Registry. |
<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>
### Release ### Release
...@@ -294,257 +149,112 @@ Spend less time configuring your tools, and more time creating. Whether you’re ...@@ -294,257 +149,112 @@ Spend less time configuring your tools, and more time creating. Whether you’re
deploying to one server or thousands, build, test, and release your code deploying to one server or thousands, build, test, and release your code
confidently and securely with GitLab’s built-in Continuous Delivery and Deployment. confidently and securely with GitLab’s built-in Continuous Delivery and Deployment.
The following documentation relates to the DevOps **Release** stage: - [Auto Deploy](topics/autodevops/index.md#auto-deploy): Configure GitLab CI 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.
| Release Topics | Description | - [GitLab Pages](user/project/pages/index.md): Build, test, and deploy a static site directly from GitLab.
|:------------------------------------------------------------|:---------------------------------------------------------------------------------------------| - [Scheduled Pipelines](user/project/pipelines/schedules.md)
| [Auto Deploy](topics/autodevops/index.md#auto-deploy) | Configure GitLab for the deployment of your application. | - [Protected Runners](ci/runners/README.md#protected-runners)
| [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. |
| [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. |
<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>
### Configure ### Configure
Automate your entire workflow from build to deploy and monitoring with GitLab Automate your entire workflow from build to deploy and monitoring with GitLab
Auto DevOps. Best practice templates get you started with minimal to zero Auto Devops. Best practice templates get you started with minimal to zero
configuration. Then customize everything from buildpacks to CI/CD. configuration. Then customize everything from buildpacks to CI/CD.
The following documentation relates to the DevOps **Configure** stage: - [Auto DevOps](topics/autodevops/index.md)
- [Deployment of Helm, Ingress, and Prometheus on Kubernetes](user/project/clusters/index.md#installing-applications)
| Configure Topics | Description | - [Protected variables](ci/variables/README.md#protected-variables)
|:-------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------| - [Easy creation of Kubernetes clusters on GKE](user/project/clusters/index.md#adding-and-creating-a-new-gke-cluster-via-gitlab)
| [Auto DevOps](topics/autodevops/index.md) | Automatically employ a complete DevOps lifecycle. | - [Executable Runbooks](user/project/clusters/runbooks/index.md)
| [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. |
| [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) | Enable and use slash commands from within Mattermost. |
| [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) | Enable and use slash commands from within Slack. |
<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>
### Monitor ### Monitor
Ensure your applications are always responsive and available. Measure how long it takes to go from planning to monitoring and ensure your
applications are always responsive and available. GitLab collects and displays
GitLab collects and displays performance metrics for deployed applications so you can know in an performance metrics for deployed apps using Prometheus 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: - [GitLab Prometheus](administration/monitoring/prometheus/index.md): Configure the bundled Prometheus to collect various metrics from your GitLab instance.
- [Prometheus project integration](user/project/integrations/prometheus.md): Configure the Prometheus integration per project and monitor your CI/CD environments.
- [Prometheus metrics](user/project/integrations/prometheus_library/metrics.md): Let Prometheus collect metrics from various services, like Kubernetes, NGINX, NGINX ingress controller, HAProxy, and Amazon Cloud Watch.
- [GitLab Performance Monitoring](administration/monitoring/performance/index.md): Use InfluxDB and Grafana to monitor the performance of your GitLab instance (will be eventually replaced by Prometheus).
- [Health check](user/admin_area/monitoring/health_check.md): GitLab provides liveness and readiness probes to indicate service health and reachability to required services.
- [GitLab Cycle Analytics](user/project/cycle_analytics.md): Cycle Analytics measures the time it takes to go from an
[idea to production](https://about.gitlab.com/2016/08/05/continuous-integration-delivery-and-deployment-with-gitlab/#from-idea-to-production-with-gitlab) for each project you have.
| Monitor Topics | Description | ## Getting started with GitLab
|:------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|
| [GitLab Performance Monitoring](administration/monitoring/performance/index.md) **[CORE ONLY]** | Use InfluxDB and Grafana to monitor the performance of your GitLab instance (will be eventually replaced by Prometheus). |
| [GitLab Prometheus](administration/monitoring/prometheus/index.md) **[CORE ONLY]** | Configure the bundled Prometheus to collect various metrics from your GitLab instance. |
| [Health check](user/admin_area/monitoring/health_check.md) | GitLab provides liveness and readiness probes to indicate service health and reachability to required services. |
| [Prometheus project integration](user/project/integrations/prometheus.md) | Configure the Prometheus integration per project and monitor your CI/CD environments. |
| [Prometheus metrics](user/project/integrations/prometheus_library/metrics.md) | Let Prometheus collect metrics from various services, like Kubernetes, NGINX, NGINX ingress controller, HAProxy, and Amazon Cloud Watch. |
<div align="right"> - [GitLab Basics](gitlab-basics/README.md): Start working on your command line and on GitLab.
<a type="button" class="btn btn-default" href="#overview"> - [GitLab Workflow](workflow/README.md): Enhance your workflow with the best of GitLab Workflow.
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i> - See also [GitLab Workflow - an overview](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/).
</a> - [GitLab Markdown](user/markdown.md): GitLab's advanced formatting system (GitLab Flavored Markdown).
</div>
### Secure ### User account
GitLab can help you secure your applications from within your development lifecycle. - [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 (external/guest/reporter/developer/maintainer/owner) can do.
The following documentation relates to the DevOps **Secure** stage: ### Git and GitLab
| Monitor Topics | Description | - [Git](topics/git/index.md): Getting started with Git, branching strategies, Git LFS, advanced use.
|:----------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------| - [Git cheatsheet](https://about.gitlab.com/images/press/git-cheat-sheet.pdf): Download a PDF describing the most used Git operations.
| [Container Scanning example](ci/examples/container_scanning.md) | `.gitlab-ci.yml` example of using Clair and clair-scanner to scan docker images for known vulnerabilities. | - [GitLab Flow](workflow/gitlab_flow.md): explore the best of Git with the GitLab Flow strategy.
NOTE: **Note:** ## Administrator documentation
Viewing [Container Scanning reports](https://docs.gitlab.com/ee/user/project/merge_requests/container_scanning.html) within merge requests requires [GitLab Ultimate](https://about.gitlab.com/pricing/).
## Subscribe to GitLab [Administration documentation](administration/index.md) applies to admin users of GitLab
self-hosted instances.
There are two ways to use GitLab: Learn how to install, configure, update, upgrade, integrate, and maintain your own instance.
Regular users don't have access to GitLab administration tools and settings.
- [GitLab self-managed](#gitlab-self-managed): Install, administer, and maintain your own GitLab instance. ## Contributor documentation
- [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.
The following sections outline tiers and features within GitLab self-managed and GitLab.com. 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/).
Learn how to contribute to GitLab:
<div align="right"> - [Development](development/README.md): All styleguides and explanations how to contribute.
<a type="button" class="btn btn-default" href="#overview"> - [Legal](legal/README.md): Contributor license agreements.
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i> - [Writing documentation](development/documentation/index.md): Contributing to GitLab Docs.
</a>
</div>
### GitLab self-managed ## GitLab subscriptions
With GitLab self-managed, you deploy your own GitLab instance on-premises or on a cloud of your choice. You have two options to use GitLab:
GitLab self-managed is available for [free and with paid subscriptions](https://about.gitlab.com/pricing/#self-managed) in the following tiers:
| Tier | Includes | - GitLab self-hosted: Install, administer, and maintain your own GitLab instance.
|:---------|:-----------------------------------------------| - GitLab.com: GitLab's SaaS offering. You don't need to install anything to use GitLab.com,
| Core | Core features. | you only need to [sign up](https://gitlab.com/users/sign_in) and start using GitLab
| Starter | Core and Starter features. | straight away.
| Premium | Core, Starter, and Premium features. |
| Ultimate | Core, Starter, Premium, and Ultimate features. |
The following resources are available for more information on GitLab self-managed: ### GitLab self-hosted
- [Feature comparison](https://about.gitlab.com/pricing/self-managed/feature-comparison/), for information on what features are available at each tier. With GitLab self-hosted, you deploy your own GitLab instance on-premises or on a private cloud of your choice. GitLab self-hosted is available for [free and with paid subscriptions](https://about.gitlab.com/pricing/): Core, Starter, Premium, and Ultimate.
- [GitLab pricing page](https://about.gitlab.com/pricing/#self-managed), for subscription information and a free trial.
- Our [product marketing page](https://about.gitlab.com/handbook/marketing/product-marketing/), for additional information including:
- How [different tiers are licensed](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers).
- The different [GitLab distributions](https://about.gitlab.com/handbook/marketing/product-marketing/#distributions).
<div align="right"> Every feature available in Core is also available in Starter, Premium, and Ultimate.
<a type="button" class="btn btn-default" href="#overview"> Starter features are also available in Premium and Ultimate, and Premium features are also
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i> available in Ultimate.
</a>
</div>
### GitLab.com ### GitLab.com
GitLab.com is hosted, managed, and administered by GitLab, Inc., with GitLab.com is hosted, managed, and administered by GitLab, Inc., with
[free and paid subscriptions](https://about.gitlab.com/pricing/) for individuals [free and paid subscriptions](https://about.gitlab.com/gitlab-com/) for individuals
and teams in the following tiers: and teams: Free, Bronze, Silver, and Gold.
| 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.
The following resources are available for more information on GitLab.com:
- [Feature comparison](https://about.gitlab.com/pricing/gitlab-com/feature-comparison/), for information on what features are available at each tier.
- [GitLab pricing page](https://about.gitlab.com/pricing/), for subscription information and a free trial.
- Our [product marketing page](https://about.gitlab.com/handbook/marketing/product-marketing/), for additional information including:
- How [different tiers are licensed](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers).
- The different [GitLab distributions](https://about.gitlab.com/handbook/marketing/product-marketing/#distributions).
<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>
## New to Git and GitLab?
Working with new systems can be daunting.
We have the following documentation to rapidly uplift your GitLab knowledge:
| 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">
<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>
### User account
Learn more about GitLab account management:
| Topic | Description |
|:-----------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------|
| [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">
<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>
### Git and GitLab GitLab.com subscriptions grants access
to the same features available in GitLab self-hosted, **except
Learn more about using Git, and using Git with GitLab: [administration](administration/index.md) tools and settings**:
| Topic | Description |
|:----------------------------------------------------------------------------|:---------------------------------------------------------------------------|
| [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">
<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>
## Coming to GitLab from another platform
If you are coming to GitLab from another platform, you'll find the following information useful:
| Topic | Description |
|:---------------------------------------------------------------|:---------------------------------------------------------------------------------------|
| [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">
<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>
## Building an integration with GitLab
There are many ways to integrate with GitLab, including:
| Topic | Description |
|:-----------------------------------------------------------|:------------------------------------------------|
| [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">
<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>
## Contributing to GitLab
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/).
Learn how to contribute to GitLab with the following resources: - 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
| Topic | Description | For supporting the open source community and encouraging the development of
|:------------------------------------------------------------|:-----------------------------------------| open source projects, GitLab grants access to **Gold** features
| [Development](development/README.md) | How to contribute to GitLab development. | for all GitLab.com **public** projects, regardless of the subscription.
| [Legal](legal/README.md) | Contributor license agreements. |
| [Writing documentation](development/documentation/index.md) | How to contribute to GitLab Docs. |
<div align="right"> To know more about GitLab subscriptions and licensing, please refer to the
<a type="button" class="btn btn-default" href="#overview"> [GitLab Product Marketing Handbook](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers).
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
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