Docs organize main page by product category
This commit is contained in:
Marcia Ramos
🚄 Job van der Voort 🚀
parent
41465270b2
commit
4efa5c4fd6
172
doc/README.md
172
doc/README.md
|
|
@ -11,35 +11,62 @@ GitLab offers the most scalable Git-based fully integrated platform for
|
|||
software development, with flexible products and subscriptions.
|
||||
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) |
|
||||
| [Configuring `.gitlab-ci.yml`](ci/yaml/README.md) | [SSH authentication](ssh/README.md) |
|
||||
| [Using Docker images](ci/docker/using_docker_images.md) | [GitLab Pages](user/project/pages/index.md) |
|
||||
| [User documentation](user/index.md) | [GitLab CI/CD](ci/README.md) |
|
||||
| [Administrator documentation](administration/index.md) | [GitLab CI/CD quick start guide](ci/quick_start/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) |
|
||||
|
||||
- [User documentation](user/index.md)
|
||||
- [Administrator documentation](administration/index.md)
|
||||
- [Contributor documentation](#contributor-documentation)
|
||||
## Complete DevOps with GitLab
|
||||
|
||||
## Getting started 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).
|
||||
|
||||
- [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.
|
||||
- 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).
|
||||
|
||||
|
||||
### 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 Board](user/project/issue_board.md)
|
||||
- [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.
|
||||
- [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.
|
||||
- [Auto DevOps](topics/autodevops/index.md)
|
||||
|
||||
### User account
|
||||
#### Migrate and import your projects from other platforms
|
||||
|
||||
- [User account](user/profile/index.md): Manage your account
|
||||
- [Authentication](topics/authentication/index.md): Account security with two-factor authentication, setup 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/master/owner) can do.
|
||||
- [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.
|
||||
|
||||
### Projects and groups
|
||||
### Create
|
||||
|
||||
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.
|
||||
GitLab’s git repositories come complete with branching tools and access
|
||||
controls, providing a scalable, single source of truth for collaborating
|
||||
on projects and code.
|
||||
|
||||
#### Projects and groups
|
||||
|
||||
- [Projects](user/project/index.md):
|
||||
- [Project settings](user/project/settings/index.md)
|
||||
|
|
@ -54,7 +81,7 @@ To understand what features you have access to, check the [GitLab subscriptions]
|
|||
- [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.
|
||||
|
||||
### Repository
|
||||
#### Repositories
|
||||
|
||||
Manage your [repositories](user/project/repository/index.md) from the UI (user interface):
|
||||
|
||||
|
|
@ -72,21 +99,82 @@ Manage your [repositories](user/project/repository/index.md) from the UI (user i
|
|||
- [Commits](user/project/repository/index.md#commits)
|
||||
- [Signing commits](user/project/repository/gpg_signed_commits/index.md): use GPG to sign your commits.
|
||||
|
||||
### 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
|
||||
|
||||
#### 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 Board](user/project/issue_board.md#group-issue-board)
|
||||
- [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)
|
||||
- [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.
|
||||
- [Checkout merge requests locally](user/project/merge_requests/index.md#checkout-merge-requests-locally)
|
||||
- [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.
|
||||
- [Todos](workflow/todos.md): A chronological list of to-dos that are waiting for your input, all in a simple dashboard.
|
||||
- [Review Apps](ci/review_apps/index.md): Preview changes to your app right from a merge request.
|
||||
|
||||
### Package
|
||||
|
||||
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
|
||||
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.
|
||||
|
||||
### Release
|
||||
|
||||
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.
|
||||
|
||||
- [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 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.
|
||||
|
||||
### 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 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 Performance Monitoring](administration/monitoring/performance/index.md)
|
||||
|
||||
## Getting started with 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.
|
||||
- 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).
|
||||
|
||||
### User account
|
||||
|
||||
- [User account](user/profile/index.md): Manage your account
|
||||
- [Authentication](topics/authentication/index.md): Account security with two-factor authentication, setup 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/master/owner) can do.
|
||||
|
||||
### Git and GitLab
|
||||
|
||||
|
|
@ -94,30 +182,6 @@ Manage your [repositories](user/project/repository/index.md) from the UI (user i
|
|||
- [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.
|
||||
|
||||
### Migrate and import your projects from other platforms
|
||||
|
||||
- [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.
|
||||
|
||||
### Continuous Integration, Delivery, and Deployment
|
||||
|
||||
- [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.
|
||||
- [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.
|
||||
|
||||
### 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.
|
||||
|
||||
### 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
|
||||
|
||||
## Administrator documentation
|
||||
|
||||
[Administration documentation](administration/index.md) applies to admin users of GitLab
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 64 KiB |
Loading…
Reference in New Issue