Commit aa329e3a authored by Marcia Ramos's avatar Marcia Ramos Committed by Achilleas Pipinellis

Docs: review product categories in doc/README

parent 80695a59
...@@ -15,8 +15,8 @@ To understand what features you have access to, check the [GitLab subscriptions] ...@@ -15,8 +15,8 @@ To understand what features you have access to, check the [GitLab subscriptions]
| General documentation | GitLab CI/CD docs | | General documentation | GitLab CI/CD docs |
| :----- | :----- | | :----- | :----- |
| [User documentation](user/index.md) | [GitLab CI/CD](ci/README.md) | | [User documentation](user/index.md) | [GitLab CI/CD quick start guide](ci/quick_start/README.md) |
| [Administrator documentation](administration/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) | | [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) | | [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) | | [API](api/README.md) | [Auto DevOps](topics/autodevops/index.md) |
...@@ -56,6 +56,7 @@ management tools. ...@@ -56,6 +56,7 @@ management tools.
- [Burndown Charts](user/project/milestones/burndown_charts.md): Watch your project's progress throughout a specific milestone. **[STARTER]** - [Burndown Charts](user/project/milestones/burndown_charts.md): Watch your project's progress throughout a specific milestone. **[STARTER]**
- [Todos](workflow/todos.md): A chronological list of to-dos that are waiting for your input, all in a simple dashboard. - [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. - [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.
- [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]**
#### Migrate and import your projects from other platforms #### Migrate and import your projects from other platforms
...@@ -89,7 +90,6 @@ on projects and code. ...@@ -89,7 +90,6 @@ on projects and code.
- [Advanced Syntax Search](user/search/advanced_search_syntax.md): Use advanced queries for more targeted search results. **[STARTER]** - [Advanced Syntax Search](user/search/advanced_search_syntax.md): Use advanced queries for more targeted search results. **[STARTER]**
- [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 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]**
- [Web IDE](user/project/web_ide/index.md) - [Web IDE](user/project/web_ide/index.md)
#### Repositories #### Repositories
...@@ -100,6 +100,7 @@ Manage your [repositories](user/project/repository/index.md) from the UI (user i ...@@ -100,6 +100,7 @@ Manage your [repositories](user/project/repository/index.md) from the UI (user i
- [Create a file](user/project/repository/web_editor.md#create-a-file) - [Create a file](user/project/repository/web_editor.md#create-a-file)
- [Upload a file](user/project/repository/web_editor.md#upload-a-file) - [Upload a file](user/project/repository/web_editor.md#upload-a-file)
- [File templates](user/project/repository/web_editor.md#template-dropdowns) - [File templates](user/project/repository/web_editor.md#template-dropdowns)
- [Jupyter Notebook files](user/project/repository/index.md#jupyter-notebook-files)
- [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)
- [File locking](user/project/file_lock.md): Lock a file to avoid merge conflicts. **[PREMIUM]** - [File locking](user/project/file_lock.md): Lock a file to avoid merge conflicts. **[PREMIUM]**
...@@ -113,6 +114,14 @@ Manage your [repositories](user/project/repository/index.md) from the UI (user i ...@@ -113,6 +114,14 @@ Manage your [repositories](user/project/repository/index.md) from the UI (user i
- [Repository Mirroring](workflow/repository_mirroring.md) **[STARTER]** - [Repository Mirroring](workflow/repository_mirroring.md) **[STARTER]**
- [Push rules](push_rules/push_rules.md): Additional control over pushes to your project. **[STARTER]** - [Push rules](push_rules/push_rules.md): Additional control over pushes to your project. **[STARTER]**
#### Merge Requests
- [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.
- [Checkout merge requests locally](user/project/merge_requests/index.md#checkout-merge-requests-locally)
- [Cherry-pick](user/project/merge_requests/cherry_pick_changes.md)
#### Integrations #### Integrations
- [Project Services](user/project/integrations/project_services.md): Integrate a project with external services, such as CI and chat. - [Project Services](user/project/integrations/project_services.md): Integrate a project with external services, such as CI and chat.
...@@ -127,20 +136,22 @@ Manage your [repositories](user/project/repository/index.md) from the UI (user i ...@@ -127,20 +136,22 @@ Manage your [repositories](user/project/repository/index.md) from the UI (user i
### Verify ### Verify
Spot errors sooner and shorten feedback cycles with built-in code review, code testing, Spot errors sooner, improve security and shorten feedback cycles with built-in
Code Quality, and Review Apps. Customize your approval workflow controls, automatically static code analysis, code testing, code quality, dependency checking and review
test the quality of your code, and spin up a staging environment for every code change. apps. Customize your approval workflow controls, automatically test the quality
GitLab Continuous Integration is the most popular next generation testing system that of your code, and spin up a staging environment for every code change. GitLab
auto scales to run your tests faster. Continuous Integration is the most popular next generation testing system that
scales to run your tests faster.
- [Merge Requests](user/project/merge_requests/index.md) - [GitLab CI/CD](ci/README.md): Explore the features and capabilities of Continuous Integration, Continuous Delivery, and Continuous Deployment with GitLab.
- [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 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]**
- [Static Application Security Testing](user/project/merge_requests/sast.md): Scan your code for vulnerabilities and display the results in merge requests. **[ULTIMATE]**
- [Checkout merge requests locally](user/project/merge_requests/index.md#checkout-merge-requests-locally)
- [Cherry-pick](user/project/merge_requests/cherry_pick_changes.md)
- [Review Apps](ci/review_apps/index.md): Preview changes to your app right from a merge request. - [Review Apps](ci/review_apps/index.md): Preview changes to your app right from a merge request.
- [Pipeline Graphs](ci/pipelines.md#pipeline-graphs)
- [Multi-project pipeline graphs](ci/multi_project_pipeline_graphs.md) **[PREMIUM]**
- [Code Quality](user/project/merge_requests/code_quality_diff.md) **[STARTER]**
- [Static Application Security Testing (SAST)](user/project/merge_requests/sast.md) **[ULTIMATE]**
- [Dynamic Application Security Testing (DAST)](user/project/merge_requests/dast.md) **[ULTIMATE]**
- [Container Scanning](ci/examples/container_scanning.md) **[ULTIMATE]**
- [Dependency Scanning](ci/examples/dependency_scanning.md) **[ULTIMATE]**
### Package ### Package
...@@ -148,7 +159,6 @@ GitLab Container Registry gives you the enhanced security and access controls of ...@@ -148,7 +159,6 @@ 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 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. - [GitLab Container Registry](user/project/container_registry.md): Learn how to use GitLab's built-in Container Registry.
### Release ### Release
...@@ -157,11 +167,13 @@ Spend less time configuring your tools, and more time creating. Whether you’re ...@@ -157,11 +167,13 @@ 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.
- [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. - [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. - [Scheduled Pipelines](user/project/pipelines/schedules.md)
- [Protected Runners](ci/runners/README.md#protected-runners)
- [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]** - [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. **[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. **[PREMIUM]**
- [Environments and deployments](ci/environments.md): With environments, you can control the continuous deployment of your software within GitLab.
### Configure ### Configure
...@@ -170,6 +182,11 @@ Auto Devops. Best practice templates get you started with minimal to zero ...@@ -170,6 +182,11 @@ 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) - [Auto DevOps](topics/autodevops/index.md)
- [Deployment of Helm, Ingress, and Prometheus on Kubernetes](user/project/clusters/index.md#installing-applications)
- [Protected secret variables](ci/variables/README.md#protected-secret-variables)
- [Easy creation of Kubernetes clusters on GKE](user/project/clusters/index.md#adding-and-creating-a-new-gke-cluster-via-gitlab)
- [Multiple Kubernetes Clusters](user/project/clusters/index.md#multiple-kubernetes-clusters) **[PREMIUM]**
- [Environment-specific secret variables](ci/variables/README.md#limiting-environment-scopes-of-secret-variables) **[PREMIUM]**
### Monitor ### Monitor
......
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