Commit b17e7d7c authored by 🚄 Job van der Voort 🚀's avatar 🚄 Job van der Voort 🚀

Merge branch 'docs-organize-by-category-ee' into 'master'

Docs organize main page by product category

See merge request gitlab-org/gitlab-ee!5052
parents 37a84198 fa2b4509
...@@ -11,35 +11,65 @@ GitLab offers the most scalable Git-based fully integrated platform for ...@@ -11,35 +11,65 @@ GitLab offers the most scalable Git-based fully integrated platform for
software development, with flexible products and subscriptions. software development, with flexible products and subscriptions.
To understand what features you have access to, check the [GitLab subscriptions](#gitlab-subscriptions) below. To understand what features you have access to, check the [GitLab subscriptions](#gitlab-subscriptions) below.
## Shortcuts to GitLab's most visited docs **Shortcuts to GitLab's most visited docs:**
| [GitLab CI/CD](ci/README.md) | Other | | General documentation | GitLab CI/CD docs |
| :----- | :----- | | :----- | :----- |
| [Quick start guide](ci/quick_start/README.md) | [API](api/README.md) | | [User documentation](user/index.md) | [GitLab CI/CD](ci/README.md) |
| [Configuring `.gitlab-ci.yml`](ci/yaml/README.md) | [SSH authentication](ssh/README.md) | | [Administrator documentation](administration/index.md) | [GitLab CI/CD quick start guide](ci/quick_start/README.md) |
| [Using Docker images](ci/docker/using_docker_images.md) | [GitLab Pages](user/project/pages/index.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) |
- [User documentation](user/index.md) | [API](api/README.md) | [Auto DevOps](topics/autodevops/index.md) |
- [Administrator documentation](administration/index.md) | [SSH authentication](ssh/README.md) | [Kubernetes integration](user/project/clusters/index.md)|
- [Contributor documentation](#contributor-documentation) | [GitLab Pages](user/project/pages/index.md) | [GitLab Container Registry](user/project/container_registry.md) |
## Complete DevOps with GitLab
GitLab is the first single application for software development, security,
and operations that enables Concurrent DevOps, making the software lifecycle
three times faster and radically improving the speed of business. GitLab
provides solutions for all the stages of the DevOps lifecycle:
[plan](#plan), [create](#create), [verify](#verify), [package](#package),
[release](#release), [configure](#configure), [monitor](#monitor).
![DevOps Lifecycle](img/devops_lifecycle.png)
### Plan
Whether you use Waterfall, Agile, or Conversational Development,
GitLab streamlines your collaborative workflows. Visualize, prioritize,
coordinate, and track your progress your way with GitLab’s flexible project
management tools.
- Chat operations
- [Mattermost slash commands](user/project/integrations/mattermost_slash_commands.md)
- [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.
- [Issues](user/project/issues/index.md)
- [Project Issue Boards](user/project/issue_board.md)
- [Group Issue Boards](user/project/issue_board.md#group-issue-boards)
- **(Starter/Premium/Ultimate)** [Related Issues](user/project/issues/related_issues.md): create a relationship between issues
- [Issues and merge requests templates](user/project/description_templates.md): Create templates for submitting new issues and merge requests.
- [Labels](user/project/labels.md): Categorize your issues or merge requests based on descriptive titles.
- [Milestones](user/project/milestones/index.md): Organize issues and merge requests into a cohesive group, optionally setting a due date.
- **(Starter/Premium/Ultimate)** [Burndown Charts](user/project/milestones/burndown_charts.md): Watch your project's progress throughout a specific milestone.
- [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.
## Getting started with GitLab #### Migrate and import your projects from other platforms
- [GitLab Basics](gitlab-basics/README.md): Start working on your command line and on GitLab. - [Importing to GitLab](user/project/import/index.md): Import your projects from GitHub, Bitbucket, GitLab.com, FogBugz and SVN into GitLab.
- [GitLab Workflow](workflow/README.md): Enhance your workflow with the best of GitLab Workflow. - [Migrating from SVN](workflow/importing/migrating_from_svn.md): Convert a SVN repository to Git and GitLab.
- See also [GitLab Workflow - an overview](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/).
- [GitLab Markdown](user/markdown.md): GitLab's advanced formatting system (GitLab Flavored Markdown).
- [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.
- [Auto DevOps](topics/autodevops/index.md)
### User account ### Create
- [User account](user/profile/index.md): Manage your account Consolidate source code into a single [DVCS](https://en.wikipedia.org/wiki/Distributed_version_control)
- [Authentication](topics/authentication/index.md): Account security with two-factor authentication, setup your ssh keys and deploy keys for secure access to your projects. that’s easily managed and controlled without disrupting your workflow.
- [Profile settings](user/profile/index.md#profile-settings): Manage your profile settings, two factor authentication and more. GitLab’s git repositories come complete with branching tools and access
- [User permissions](user/permissions.md): Learn what each role in a project (external/guest/reporter/developer/master/owner) can do. controls, providing a scalable, single source of truth for collaborating
on projects and code.
### Projects and groups #### Projects and groups
- [Projects](user/project/index.md): - [Projects](user/project/index.md):
- [Project settings](user/project/settings/index.md) - [Project settings](user/project/settings/index.md)
...@@ -52,17 +82,16 @@ To understand what features you have access to, check the [GitLab subscriptions] ...@@ -52,17 +82,16 @@ To understand what features you have access to, check the [GitLab subscriptions]
- [Subgroups](user/group/subgroups/index.md) - [Subgroups](user/group/subgroups/index.md)
- **(Ultimate)** [Epics](user/group/epics/index.md) - **(Ultimate)** [Epics](user/group/epics/index.md)
- **(Ultimate)** [Roadmap](user/group/roadmap/index.md) - **(Ultimate)** [Roadmap](user/group/roadmap/index.md)
- **(Starter/Premium)** [Contribution Analytics](user/group/contribution_analytics/index.md): See detailed statistics of group contributors. - **(Starter/Premium/Ultimate)** [Contribution Analytics](user/group/contribution_analytics/index.md): See detailed statistics of group contributors.
- [Search through GitLab](user/search/index.md): Search for issues, merge requests, projects, groups, todos, and issues in Issue Boards. - [Search through GitLab](user/search/index.md): Search for issues, merge requests, projects, groups, todos, and issues in Issue Boards.
- **(Starter/Premium)** [Advanced Global Search](user/search/advanced_global_search.md): Leverage Elasticsearch for faster, more advanced code search across your entire GitLab instance. - **(Starter/Premium/Ultimate)** [Advanced Global Search](user/search/advanced_global_search.md): Leverage Elasticsearch for faster, more advanced code search across your entire GitLab instance.
- **(Starter/Premium)** [Advanced Syntax Search](user/search/advanced_search_syntax.md): Use advanced queries for more targeted search results. - **(Starter/Premium/Ultimate)** [Advanced Syntax Search](user/search/advanced_search_syntax.md): Use advanced queries for more targeted search results.
- [Snippets](user/snippets.md): Snippets allow you to create little bits of code. - [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.
- [GitLab Pages](user/project/pages/index.md): Build, test, and deploy your static website with GitLab Pages. - **(Premium/Ultimate)** [GitLab Service Desk](user/project/service_desk.md): A simple way to allow people to create issues in your GitLab instance without needing their own user account.
- **(Premium)** [GitLab Service Desk](user/project/service_desk.md): A simple way to allow people to create issues in your GitLab instance without needing their own user account.
- **(Ultimate)** [Web IDE](user/project/web_ide/index.md) - **(Ultimate)** [Web IDE](user/project/web_ide/index.md)
### Repository #### Repositories
Manage your [repositories](user/project/repository/index.md) from the UI (user interface): Manage your [repositories](user/project/repository/index.md) from the UI (user interface):
...@@ -72,7 +101,7 @@ Manage your [repositories](user/project/repository/index.md) from the UI (user i ...@@ -72,7 +101,7 @@ Manage your [repositories](user/project/repository/index.md) from the UI (user i
- [File templates](user/project/repository/web_editor.md#template-dropdowns) - [File templates](user/project/repository/web_editor.md#template-dropdowns)
- [Create a directory](user/project/repository/web_editor.md#create-a-directory) - [Create a directory](user/project/repository/web_editor.md#create-a-directory)
- [Start a merge request](user/project/repository/web_editor.md#tips) (when committing via UI) - [Start a merge request](user/project/repository/web_editor.md#tips) (when committing via UI)
- **(Premium)** [File locking](user/project/file_lock.md): Lock a file to avoid merge conflicts. - **(Premium/Ultimate)** [File locking](user/project/file_lock.md): Lock a file to avoid merge conflicts.
- [Branches](user/project/repository/branches/index.md) - [Branches](user/project/repository/branches/index.md)
- [Default branch](user/project/repository/branches/index.md#default-branch) - [Default branch](user/project/repository/branches/index.md#default-branch)
- [Create a branch](user/project/repository/web_editor.md#create-a-new-branch) - [Create a branch](user/project/repository/web_editor.md#create-a-new-branch)
...@@ -80,62 +109,96 @@ Manage your [repositories](user/project/repository/index.md) from the UI (user i ...@@ -80,62 +109,96 @@ Manage your [repositories](user/project/repository/index.md) from the UI (user i
- [Delete merged branches](user/project/repository/branches/index.md#delete-merged-branches) - [Delete merged branches](user/project/repository/branches/index.md#delete-merged-branches)
- [Commits](user/project/repository/index.md#commits) - [Commits](user/project/repository/index.md#commits)
- [Signing commits](user/project/repository/gpg_signed_commits/index.md): use GPG to sign your commits. - [Signing commits](user/project/repository/gpg_signed_commits/index.md): use GPG to sign your commits.
- **(Starter/Premium)** [Repository Mirroring](workflow/repository_mirroring.md) - **(Starter/Premium/Ultimate)** [Repository Mirroring](workflow/repository_mirroring.md)
- **(Starter/Premium)** [Push rules](push_rules/push_rules.md): Additional control over pushes to your project. - **(Starter/Premium/Ultimate)** [Push rules](push_rules/push_rules.md): Additional control over pushes to your project.
### Issues and Merge Requests (MRs) #### Integrations
- [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
- **(Premium/Ultimate)** [JIRA Development Panel](integration/jira_development_panel.md): See GitLab information in the JIRA Development Panel
#### Automation
- [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.
### Verify
Spot errors sooner and shorten feedback cycles with built-in code review, code testing,
Code Quality, and Review Apps. Customize your approval workflow controls, automatically
test the quality 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
auto scales to run your tests faster.
- [Discussions](user/discussions/index.md): Threads, comments, and resolvable discussions in issues, commits, and merge requests.
- [Issues](user/project/issues/index.md)
- [Project issue Board](user/project/issue_board.md)
- [Group Issue Boards](user/project/issue_board.md#group-issue-boards)
- **(Starter/Premium)** [Related Issues](user/project/issues/related_issues.md): create a relationship between issues
- [Issues and merge requests templates](user/project/description_templates.md): Create templates for submitting new issues and merge requests.
- [Labels](user/project/labels.md): Categorize your issues or merge requests based on descriptive titles.
- [Merge Requests](user/project/merge_requests/index.md) - [Merge Requests](user/project/merge_requests/index.md)
- [Work In Progress Merge Requests](user/project/merge_requests/work_in_progress_merge_requests.md) - [Work In Progress 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 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.
- **(Starter/Premium)** [Merge Request approval](user/project/merge_requests/merge_request_approvals.md): Make sure every merge request is approved by one or more people before getting merged. - **(Starter/Premium/Ultimate)** [Merge Request approval](user/project/merge_requests/merge_request_approvals.md): Make sure every merge request is approved by one or more people before getting merged.
- **(Ultimate)** [Static Application Security Testing](user/project/merge_requests/sast.md): Scan your code for vulnerabilities and display the results in merge requests. - **(Ultimate)** [Static Application Security Testing](user/project/merge_requests/sast.md): Scan your code for vulnerabilities and display the results in merge requests.
- [Checkout merge requests locally](user/project/merge_requests/index.md#checkout-merge-requests-locally) - [Checkout merge requests locally](user/project/merge_requests/index.md#checkout-merge-requests-locally)
- [Cherry-pick](user/project/merge_requests/cherry_pick_changes.md) - [Cherry-pick](user/project/merge_requests/cherry_pick_changes.md)
- [Milestones](user/project/milestones/index.md): Organize issues and merge requests into a cohesive group, optionally setting a due date. - [Review Apps](ci/review_apps/index.md): Preview changes to your app right from a merge request.
- **(Starter/Premium)** [Burndown Charts](user/project/milestones/burndown_charts.md): Watch your project's progress throughout a specific milestone.
- [Related issues](user/project/issues/related_issues.md)
- [Todos](workflow/todos.md): A chronological list of to-dos that are waiting for your input, all in a simple dashboard.
### Git and GitLab ### Package
- [Git](topics/git/index.md): Getting started with Git, branching strategies, Git LFS, advanced use. GitLab Container Registry gives you the enhanced security and access controls of
- [Git cheatsheet](https://gitlab.com/gitlab-com/marketing/raw/master/design/print/git-cheatsheet/print-pdf/git-cheatsheet.pdf): Download a PDF describing the most used Git operations. custom Docker images without 3rd party add-ons. Easily upload and download images
- [GitLab Flow](workflow/gitlab_flow.md): explore the best of Git with the GitLab Flow strategy. from GitLab CI/CD with full Git repository management integration.
### Migrate and import your projects from other platforms - [GitLab CI/CD](ci/README.md): Explore the features and capabilities of Continuous Integration, Continuous Delivery, and Continuous Deployment with GitLab.
- [GitLab Container Registry](user/project/container_registry.md): Learn how to use GitLab's built-in Container Registry.
- [Importing to GitLab](user/project/import/index.md): Import your projects from GitHub, Bitbucket, GitLab.com, FogBugz and SVN into GitLab. ### Release
- [Migrating from SVN](workflow/importing/migrating_from_svn.md): Convert a SVN repository to Git and GitLab.
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
confidently and securely with GitLab’s built-in Continuous Delivery and Deployment.
### Continuous Integration, Delivery, and Deployment - [GitLab Pages](user/project/pages/index.md): Build, test, and deploy a static site directly from GitLab.
- [Auto Deploy](topics/autodevops/index.md#auto-deploy): Configure GitLab CI/CD for the deployment of your application.
- **(Premium/Ultimate)** [Deploy Boards](user/project/deploy_boards.md): View of the current health and status of each CI environment running on Kubernetes, displaying the status of the pods in the deployment.
- **(Premium/Ultimate)** [Canary Deployments](user/project/canary_deployments.md): A popular CI strategy, where a small portion of the fleet is updated to the new version first.
- [Environments and deployments](ci/environments.md): With environments, you can control the continuous deployment of your software within GitLab.
### Configure
Automate your entire workflow from build to deploy and monitoring with GitLab
Auto Devops. Best practice templates get you started with minimal to zero
configuration. Then customize everything from buildpacks to CI/CD.
- [Auto DevOps](topics/autodevops/index.md)
### Monitor
Measure how long it takes to go from planning to monitoring and ensure your
applications are always responsive and available. 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.
- [GitLab CI](ci/README.md): Explore the features and capabilities of Continuous Integration, Continuous Delivery, and Continuous Deployment with GitLab.
- [Auto Deploy](ci/autodeploy/index.md): Configure GitLab CI for the deployment of your application.
- [Review Apps](ci/review_apps/index.md): Preview changes to your app right from a merge request.
- **(Premium)** [Deploy Boards](user/project/deploy_boards.md): View of the current health and status of each CI environment running on Kubernetes, displaying the status of the pods in the deployment.
- **(Premium)** [Canary Deployments](user/project/canary_deployments.md): A popular CI strategy, where a small portion of the fleet is updated to the new version first.
- [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. - [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.
- [GitLab Container Registry](user/project/container_registry.md): Learn how to use GitLab's built-in Container Registry. - [GitLab Performance Monitoring](administration/monitoring/performance/index.md)
### Automation ## Getting started with GitLab
- [API](api/README.md): Automate GitLab via a simple and powerful API. - [GitLab Basics](gitlab-basics/README.md): Start working on your command line and on GitLab.
- [GitLab Webhooks](user/project/integrations/webhooks.md): Let GitLab notify you when new code has been pushed to your project. - [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 Markdown](user/markdown.md): GitLab's advanced formatting system (GitLab Flavored Markdown).
### Integrations ### User account
- [Project Services](user/project/integrations/project_services.md): Integrate a project with external services, such as CI and chat. - [User account](user/profile/index.md): Manage your account
- [GitLab Integration](integration/README.md): Integrate with multiple third-party services with GitLab to allow external issue trackers and external authentication. - [Authentication](topics/authentication/index.md): Account security with two-factor authentication, setup your ssh keys and deploy keys for secure access to your projects.
- [Trello Power-Up](integration/trello_power_up.md): Integrate with GitLab's Trello Power-Up - [Profile settings](user/profile/index.md#profile-settings): Manage your profile settings, two factor authentication and more.
- **(Premium)** [JIRA Development Panel](integration/jira_development_panel.md): See GitLab information in the JIRA Development Panel - [User permissions](user/permissions.md): Learn what each role in a project (external/guest/reporter/developer/master/owner) can do.
### Git and GitLab
- [Git](topics/git/index.md): Getting started with Git, branching strategies, Git LFS, advanced use.
- [Git cheatsheet](https://gitlab.com/gitlab-com/marketing/raw/master/design/print/git-cheatsheet/print-pdf/git-cheatsheet.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.
## Administrator documentation ## Administrator documentation
......
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