Skip to content

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

Refactor landing page 

Includes:

- Orientating page around audiences.
- Adding descriptions to all links.
- Light restructuring.
- Minor fixes.
parent 29d8179b
Show whitespace changes
Inline Side-by-side
Showing with 300 additions and 155 deletions
doc/README.md
View file @ b9dab580
...@@ -5,135 +5,220 @@ description: 'Learn how to use and administer GitLab, the most scalable Git-base ...@@ -5,135 +5,220 @@ description: 'Learn how to use and administer GitLab, the most scalable Git-base
# GitLab Documentation # GitLab Documentation
Welcome to [GitLab](https://about.gitlab.com/), a Git-based fully featured Welcome to [GitLab](https://about.gitlab.com/) Documentation.
platform for software development!
Here you can access the complete documentation for GitLab, the single application for the
GitLab offers the most scalable Git-based fully integrated platform for [entire DevOps lifecycle](#complete-devops-with-gitlab).
software development, with flexible products and subscriptions.
To understand what features you have access to, check the [GitLab subscriptions](#gitlab-subscriptions) below. ## Overview
**Shortcuts to GitLab's most visited docs:** No matter how you use GitLab, we have documentation for you.
| General documentation | GitLab CI/CD docs | <table>
| :----- | :----- | <tbody>
| [User documentation](user/index.md) | [GitLab CI/CD quick start guide](ci/quick_start/README.md) | <tr>
| [Administrator documentation](administration/index.md) | [GitLab CI/CD examples](ci/examples/README.md) | <td>
| [Contributor documentation](#contributor-documentation) | [Configuring `.gitlab-ci.yml`](ci/yaml/README.md) | <a href="user/index.md"><strong>User documentation</strong></a>
| [Getting started with GitLab](#getting-started-with-gitlab) | [Using Docker images](ci/docker/using_docker_images.md) | <br/><br/>
| [API](api/README.md) | [Auto DevOps](topics/autodevops/index.md) | Discover features and concepts for GitLab users.
| [SSH authentication](ssh/README.md) | [Kubernetes integration](user/project/clusters/index.md)| </td>
| [GitLab Pages](user/project/pages/index.md) | [GitLab Container Registry](user/project/container_registry.md) | <td>
<a href="administration/index.md"><strong>Administrator documentation</strong></a>
<br/><br/>
Everything GitLab administrators need to know.
</td>
</tr>
<tr>
<td>
<a href="#contributing-to-gitlab"><strong>Contributing to GitLab</strong></a>
<br/><br/>
At GitLab, everyone can contribute!
</td>
<td>
<a href="#new-to-git-and-gitlab"><strong>New to Git and GitLab?</strong></a>
<br/><br/>
We have resources to get you started.
</td>
</tr>
<tr>
<td>
<a href="#building-an-integration-with-gitlab"><strong>Building an integration with GitLab?</strong></a>
<br/><br/>
Consult our our automation and integration documentation.
</td>
<td>
<a href="#coming-to-gitlab-from-another-platform"><strong>Coming to GitLab from another platform?</strong></a>
<br/><br/>
Consult our handy guides.
</td>
</tr>
</tbody>
</table>
TIP: **Tip:**
You can also find documentation topics arranged by [DevOps Lifecycle stage](#complete-devops-with-gitlab).
## Popular Documentation
Have a look at some of our most popular documentation resources:
| Popular Page | Description |
|:----------------------------------------------------------------|:-----------------------------------------------------------------|
| [GitLab CI/CD examples](ci/examples/README.md) | Get up to speed quickly with common CI/CD scenarios. |
| [Configuring `.gitlab-ci.yml`](ci/yaml/README.md) | Complete syntax documentation for configuring your CI pipelines. |
| [Using Docker images](ci/docker/using_docker_images.md) | Build and test your applications with Docker. |
| [SSH authentication](ssh/README.md) | Secure your network communication. |
| [Kubernetes integration](user/project/clusters/index.md) | Use GitLab with Kubernetes. |
| [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. |
## Complete DevOps with GitLab ## Complete DevOps with GitLab
GitLab is the first single application for software development, security, GitLab is the first single application for software development, security,
and operations that enables Concurrent DevOps, making the software lifecycle and operations that enables Concurrent DevOps, making the software lifecycle
three times faster and radically improving the speed of business. GitLab three times faster and radically improving the speed of business.
provides solutions for all the stages of the DevOps lifecycle:
[plan](#plan), [create](#create), [verify](#verify), [package](#package), GitLab provides solutions for all the stages of the DevOps lifecycle:
[release](#release), [configure](#configure), [monitor](#monitor).
<img class="image-noshadow" src="img/devops_lifecycle.png" alt="DevOps Lifecycle"> <img class="image-noshadow" src="img/devops_lifecycle.png" alt="DevOps Lifecycle">
The following sections provide links to documentation for each DevOps stage:
| DevOps Stage | Documentation for |
|:------------------------|:-----------------------------------|
| [Plan](#plan) | Project management tools. |
| [Create](#create) | Source code version control tools. |
| [Verify](#verify) | Testing and code quality tools. |
| [Package](#package) | Code packaging tools. |
| [Release](#release) | Code release tools. |
| [Configure](#configure) | Configuration tools. |
| [Monitor](#monitor) | Application monitoring. |
### Plan ### Plan
Whether you use Waterfall, Agile, or Conversational Development, Whether you use Waterfall, Agile, or Conversational Development,
GitLab streamlines your collaborative workflows. Visualize, prioritize, GitLab streamlines your collaborative workflows.
coordinate, and track your progress your way with GitLab’s flexible project
Visualize, prioritize, coordinate, and track your progress your way with GitLab’s flexible project
management tools. management tools.
- Chat operations The following documentation relates to the DevOps **Plan** stage:
- [Mattermost slash commands](user/project/integrations/mattermost_slash_commands.md)
- [Slack slash commands](user/project/integrations/slack_slash_commands.md) | Plan Topics | Description |
- [Discussions](user/discussions/index.md): Threads, comments, and resolvable discussions in issues, commits, and merge requests. |:-----------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------|
- [Issues](user/project/issues/index.md) | [Discussions](user/discussions/index.md) | Threads, comments, and resolvable discussions in issues, commits, and merge requests. |
- [Project Issue Board](user/project/issue_board.md) | [Issues](user/project/issues/index.md) | Project issues. |
- [Issues and merge requests templates](user/project/description_templates.md): Create templates for submitting new issues and merge requests. | [Project Issue Board](user/project/issue_board.md) | Project issue boards. |
- [Labels](user/project/labels.md): Categorize your issues or merge requests based on descriptive titles. | [Issues and merge requests templates](user/project/description_templates.md) | Create templates for submitting new issues and merge requests. |
- [Milestones](user/project/milestones/index.md): Organize issues and merge requests into a cohesive group, optionally setting a due date. | [Labels](user/project/labels.md) | Categorize your issues or merge requests based on descriptive titles. |
- [Todos](workflow/todos.md): A chronological list of to-dos that are waiting for your input, all in a simple dashboard. | [Milestones](user/project/milestones/index.md) | Organize issues and merge requests into a cohesive group, optionally setting a due date. |
- [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. | [Todos](workflow/todos.md) | A chronological list of to-dos that are waiting for your input, all in a simple dashboard. |
| [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. |
#### Migrate and import your projects from other platforms
See also chat operations documentation:
- [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. - [Mattermost slash commands](user/project/integrations/mattermost_slash_commands.md).
- [Slack slash commands](user/project/integrations/slack_slash_commands.md).
<div align="right">Back to <a href="#overview">Overview</a>.</div>
### Create ### Create
Consolidate source code into a single [DVCS](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.
#### Projects and groups The following documentation relates to the DevOps **Create** stage:
- [Projects](user/project/index.md): | Projects and Groups Topics | Description |
- [Project settings](user/project/settings/index.md) |:---------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------|
- [Create a project](gitlab-basics/create-project.md) | [Projects](user/project/index.md) | Host source code and bring many parts of GitLab together. |
- [Fork a project](gitlab-basics/fork-project.md) | [Project settings](user/project/settings/index.md) | Project configuration. |
- [Importing and exporting projects between instances](user/project/settings/import_export.md). | [Create a project](gitlab-basics/create-project.md) | Create a project. |
- [Project access](public_access/public_access.md): Setting up your project's visibility to public, internal, or private. | [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. | [Importing and exporting projects between instances](user/project/settings/import_export.md) | Move projects. |
- [Groups](user/group/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. |
- [Subgroups](user/group/subgroups/index.md) | [GitLab Pages](user/project/pages/index.md) | Build, test, and deploy your static website with GitLab Pages. |
- [Search through GitLab](user/search/index.md): Search for issues, merge requests, projects, groups, todos, and issues in Issue Boards. | [Groups](user/group/index.md) and [Subgroups](user/group/subgroups/index.md) | Organize your projects in groups. |
- [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. |
- [Wikis](user/project/wiki/index.md): Enhance your repository documentation with built-in wikis. | [Snippets](user/snippets.md) | Snippets allow you to create little bits of code. |
- [Web IDE](user/project/web_ide/index.md) | [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. |
#### Repositories
<div align="right">Back to <a href="#overview">Overview</a>.</div>
Manage your [repositories](user/project/repository/index.md) from the UI (user interface):
---
- [Files](user/project/repository/index.md#files)
- [Create a file](user/project/repository/web_editor.md#create-a-file) | Repositories Topics | Description |
- [Upload a file](user/project/repository/web_editor.md#upload-a-file) |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------|
- [File templates](user/project/repository/web_editor.md#template-dropdowns) | [Repositories](user/project/repository/index.md) | Manage source code repositories in GitLab's user interface. |
- [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) | [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. |
- [Start a merge request](user/project/repository/web_editor.md#tips) (when committing via UI) | [File templates](user/project/repository/web_editor.md#template-dropdowns) | File templates for common files. |
- [Branches](user/project/repository/branches/index.md) | [Jupyter Notebook files](user/project/repository/index.md#jupyter-notebook-files) | GitLab's support for `.ipynb` files. |
- [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 commiting via GitLab's user interface. |
- [Create a branch](user/project/repository/web_editor.md#create-a-new-branch) | [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. |
- [Protected branches](user/project/protected_branches.md#protected-branches) | [Create a branch](user/project/repository/web_editor.md#create-a-new-branch) | Create branches within GitLab's user interface. |
- [Delete merged branches](user/project/repository/branches/index.md#delete-merged-branches) | [Protected branches](user/project/protected_branches.md) | Use protected branches. |
- [Commits](user/project/repository/index.md#commits) | [Delete merged branches](user/project/repository/branches/index.md#delete-merged-branches) | Bulk delete branches after their changes are merged. |
- [Signing commits](user/project/repository/gpg_signed_commits/index.md): use GPG to sign your commits. | [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. |
#### Merge Requests <div align="right">Back to <a href="#overview">Overview</a>.</div>
- [Merge Requests](user/project/merge_requests/index.md) ---
- [Work In Progress "WIP" Merge Requests](user/project/merge_requests/work_in_progress_merge_requests.md)
- [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. | Merge Requests Topics | Description |
- [Checkout merge requests locally](user/project/merge_requests/index.md#checkout-merge-requests-locally) |:------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
- [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. |
#### Integrations | [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. |
- [Project Services](user/project/integrations/project_services.md): Integrate a project with external services, such as CI and chat. | [Cherry-picking](user/project/merge_requests/cherry_pick_changes.md) | Use GitLab for cherry-picking changes. |
- [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 <div align="right">Back to <a href="#overview">Overview</a>.</div>
#### Automation ---
- [API](api/README.md): Automate GitLab via a simple and powerful API. | Integrations Topics | Description |
- [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. |
| [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. |
<div align="right">Back to <a href="#overview">Overview</a>.</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">Back to <a href="#overview">Overview</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. GitLab of your code, and spin up a staging environment for every code change.
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.
- [GitLab CI/CD](ci/README.md): Explore the features and capabilities of Continuous Integration, Continuous Delivery, and Continuous Deployment with GitLab. The following documentation relates to the DevOps **Verify** stage:
- [Review Apps](ci/review_apps/index.md): Preview changes to your app right from a merge request.
- [Pipeline Graphs](ci/pipelines.md#pipeline-graphs) | Verify Topics | Description |
- [JUnit test reports](ci/junit_test_reports.md) |:---------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------|
| [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. |
| [Pipeline Graphs](ci/pipelines.md#pipeline-graphs) | Visualize builds. |
| [JUnit test reports](ci/junit_test_reports.md) | Display JUnit test reports on merge requests. |
<div align="right">Back to <a href="#overview">Overview</a>.</div>
### Package ### Package
...@@ -141,7 +226,13 @@ GitLab Container Registry gives you the enhanced security and access controls of ...@@ -141,7 +226,13 @@ 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.
- [GitLab Container Registry](user/project/container_registry.md): Learn how to use GitLab's built-in Container Registry. The following documentation relates to the DevOps **Package** stage:
| Package Topics | Description |
|:----------------------------------------------------------------|:-------------------------------------------------------|
| [GitLab Container Registry](user/project/container_registry.md) | Learn how to use GitLab's built-in Container Registry. |
<div align="right">Back to <a href="#overview">Overview</a>.</div>
### Release ### Release
...@@ -149,94 +240,115 @@ Spend less time configuring your tools, and more time creating. Whether you’re ...@@ -149,94 +240,115 @@ 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.
- [Auto Deploy](topics/autodevops/index.md#auto-deploy): Configure GitLab CI for the deployment of your application. The following documentation relates to the DevOps **Release** stage:
- [Environments and deployments](ci/environments.md): With environments, you can control the continuous deployment of your software within GitLab.
- [GitLab Pages](user/project/pages/index.md): Build, test, and deploy a static site directly from GitLab. | Release Topics | Description |
- [Scheduled Pipelines](user/project/pipelines/schedules.md) |:------------------------------------------------------------|:---------------------------------------------------------------------------------------------|
- [Protected Runners](ci/runners/README.md#protected-runners) | [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. |
| [GitLab Pages](user/project/pages/index.md) | Build, test, and deploy a static site directly from GitLab. |
| [Scheduled Pipelines](user/project/pipelines/schedules.md) | Execute pipelines on a schedule. |
| [Protected Runners](ci/runners/README.md#protected-runners) | Select Runners to only pick jobs for protected branches and tags. |
<div align="right">Back to <a href="#overview">Overview</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.
- [Auto DevOps](topics/autodevops/index.md) The following documentation relates to the DevOps **Configure** stage:
- [Deployment of Helm, Ingress, and Prometheus on Kubernetes](user/project/clusters/index.md#installing-applications)
- [Protected variables](ci/variables/README.md#protected-variables) | Configure Topics | Description |
- [Easy creation of Kubernetes clusters on GKE](user/project/clusters/index.md#adding-and-creating-a-new-gke-cluster-via-gitlab) |:-------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------|
- [Executable Runbooks](user/project/clusters/runbooks/index.md) | [Auto DevOps](topics/autodevops/index.md) | Automatically employ a complete DevOps lifecycle. |
| [Installing Applications](user/project/clusters/index.md#installing-applications) | Deploy Helm, Ingress, and Prometheus on Kubernetes. |
| [Protected variables](ci/variables/README.md#protected-variables) | Restrict variables to protected branches and tags. |
| [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. |
<div align="right">Back to <a href="#overview">Overview</a>.</div>
### Monitor ### Monitor
Measure how long it takes to go from planning to monitoring and ensure your Measure how long it takes to go from planning to monitoring and ensure your
applications are always responsive and available. GitLab collects and displays applications are always responsive and available.
performance metrics for deployed apps using Prometheus so you can know in an
GitLab collects and displays 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.
- [GitLab Prometheus](administration/monitoring/prometheus/index.md): Configure the bundled Prometheus to collect various metrics from your GitLab instance. The following documentation relates to the DevOps **Monitor** stage:
- [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. | Monitor Topics | Description |
- [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 Prometheus](administration/monitoring/prometheus/index.md) | Configure the bundled Prometheus to collect various metrics from your GitLab instance. |
- [GitLab Cycle Analytics](user/project/cycle_analytics.md): Cycle Analytics measures the time it takes to go from an | [Prometheus project integration](user/project/integrations/prometheus.md) | Configure the Prometheus integration per project and monitor your CI/CD environments. |
[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. | [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. |
<div align="right">Back to <a href="#overview">Overview</a>.</div>
## Getting started with GitLab ## New to Git and GitLab?
Working with new systems can be daunting.
We have the following documentation to rapidly uplift your GitLab knowledge:
- [GitLab Basics](gitlab-basics/README.md): Start working on your command line and on GitLab. - [GitLab Basics](gitlab-basics/README.md): Start working on your command line and on GitLab.
- [GitLab Workflow](workflow/README.md): Enhance your workflow with the best of GitLab Workflow. - [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/). - 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). - [GitLab Markdown](user/markdown.md): GitLab's advanced formatting system (GitLab Flavored Markdown).
<div align="right">Back to <a href="#overview">Overview</a>.</div>
### User account ### User account
Learn more about GitLab account management:
- [User account](user/profile/index.md): Manage your account - [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. - [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. - [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. - [User permissions](user/permissions.md): Learn what each role in a project (external/guest/reporter/developer/maintainer/owner) can do.
<div align="right">Back to <a href="#overview">Overview</a>.</div>
### Git and GitLab ### Git and GitLab
Learn more about using Git, and using Git with GitLab:
- [Git](topics/git/index.md): Getting started with Git, branching strategies, Git LFS, advanced use. - [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. - [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. - [GitLab Flow](workflow/gitlab_flow.md): explore the best of Git with the GitLab Flow strategy.
## Administrator documentation <div align="right">Back to <a href="#overview">Overview</a>.</div>
[Administration documentation](administration/index.md) applies to admin users of GitLab
self-hosted instances.
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.
## Contributor documentation
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:
- [Development](development/README.md): All styleguides and explanations how to contribute.
- [Legal](legal/README.md): Contributor license agreements.
- [Writing documentation](development/documentation/index.md): Contributing to GitLab Docs.
## GitLab subscriptions ### GitLab subscriptions
You have two options to use GitLab: You have two options to use GitLab:
- GitLab self-hosted: Install, administer, and maintain your own GitLab instance. - [GitLab self-managed](#gitlab-self-managed): 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, - [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 you only need to [sign up](https://gitlab.com/users/sign_in) and start using GitLab straight away.
straight away.
<div align="right">Back to <a href="#overview">Overview</a>.</div>
### GitLab self-hosted ### GitLab self-managed
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. 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/): Core, Starter, Premium, and Ultimate.
Every feature available in Core is also available in Starter, Premium, and Ultimate. Every feature available in Core is also available in Starter, Premium, and Ultimate.
Starter features are also available in Premium and Ultimate, and Premium features are also Starter features are also available in Premium and Ultimate, and Premium features are also
available in Ultimate. available in Ultimate.
<div align="right">Back to <a href="#overview">Overview</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
...@@ -244,17 +356,50 @@ GitLab.com is hosted, managed, and administered by GitLab, Inc., with ...@@ -244,17 +356,50 @@ GitLab.com is hosted, managed, and administered by GitLab, Inc., with
and teams: Free, Bronze, Silver, and Gold. and teams: Free, Bronze, Silver, and Gold.
GitLab.com subscriptions grants access GitLab.com subscriptions grants access
to the same features available in GitLab self-hosted, **except to the same features available in GitLab self-managed, **except
[administration](administration/index.md) tools and settings**: [administration](administration/index.md) tools and settings**:
- GitLab.com Free includes the same features available in Core - GitLab.com Free includes the same features available in Core.
- GitLab.com Bronze includes the same features available in GitLab Starter - GitLab.com Bronze includes the same features available in GitLab Starter.
- GitLab.com Silver includes the same features available in GitLab Premium - GitLab.com Silver includes the same features available in GitLab Premium.
- GitLab.com Gold includes the same features available in GitLab Ultimate - GitLab.com Gold includes the same features available in GitLab Ultimate.
For supporting the open source community and encouraging the development of For supporting the open-source community and encouraging the development of
open source projects, GitLab grants access to **Gold** features open source projects, GitLab grants access to **Gold** features
for all GitLab.com **public** projects, regardless of the subscription. for all GitLab.com **public** projects, regardless of the subscription.
To know more about GitLab subscriptions and licensing, please refer to the To know more about GitLab subscriptions and licensing, please refer to the
[GitLab Product Marketing Handbook](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers). [GitLab Product Marketing Handbook](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers).
<div align="right">Back to <a href="#overview">Overview</a>.</div>
## Coming to GitLab from another platform
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,
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">Back to <a href="#overview">Overview</a>.</div>
## Building an integration with GitLab
There are many ways to integration with GitLab, including:
- Our [API](api/README.md).
- Other [integrations](#integrations) and [automation](#automation).
<div align="right">Back to <a href="#overview">Overview</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:
- [Development](development/README.md): All styleguides and explanations how to contribute.
- [Legal](legal/README.md): Contributor license agreements.
- [Writing documentation](development/documentation/index.md): Contributing to GitLab Docs.
<div align="right">Back to <a href="#overview">Overview</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