Outline all existing CI/CD content, no matter project it belongs to
Work in Progress Map
CI/CD Documentation Structure
GitLab Repository (CI Area)
Section path doc/ci
|
Description | Scheduled actions |
---|---|---|
README.md |
Main CI/CD landing page. Recent improvements merged and more scheduled. |
Overhauled in: https://gitlab.com/gitlab-org/gitlab-ce/issues/58041. See MRs: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/25588, and https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/9737. Further progress made in https://gitlab.com/gitlab-org/gitlab-ce/issues/58323. See MRs: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/25905, and https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/9925. |
enable_or_disable_ci.md |
Short topic on how to enable and disable CD/CI. Referred to as an Administration task on landing page. |
Planned for overhaul in https://gitlab.com/gitlab-org/gitlab-ce/issues/58451. |
git_submodules.md |
Short topic on configuring and using .gitmodules file.Currently classified as "Advanced Usage" on landing page. |
Planned for overhaul in https://gitlab.com/gitlab-org/gitlab-ce/issues/58451. |
pipelines.md |
Documents pipelines and jobs. Classified as "Essential" on landing page. | Planned for overhaul in https://gitlab.com/gitlab-org/gitlab-ce/issues/58450. |
ci/examples |
Index to a series of examples for different use cases. Called out separately on the landing page. |
Overhauled in https://gitlab.com/gitlab-org/gitlab-ce/issues/58041. See MRs: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/25588, and https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/9737. |
ci/introduction/index.md |
New introductory material for GitLab CI/CD. | Added by https://gitlab.com/gitlab-org/gitlab-ce/issues/38964. |
ci/merge_request_pipelines |
Standalone topic for merge request pipelines, separate to other pipelines documentation. |
Planned for overhaul in https://gitlab.com/gitlab-org/gitlab-ce/issues/58450. |
ci/quick_start |
A getting started with GitLab CI/CD topic. Classified as "Essential" on landing page |
Currently being overhauled in https://gitlab.com/gitlab-org/gitlab-ce/issues/38964. |
ci/services |
Documents some available options when using services keyword/parameter in .gitlab.yml file.Called out separately on the landing page. |
Planned for overhaul in https://gitlab.com/gitlab-org/gitlab-ce/issues/58451. |
ci/variables |
Documents CI/CD variables that come with GitLab, how to define new ones, and how they can be used. Currently classified as "Basic Usage" on landing page. |
Planned for overhaul in https://gitlab.com/gitlab-org/gitlab-ce/issues/58451. |
ci/yaml |
Essentially a .gitlab-ci.yml reference with available options.Classified as "Essential" on landing page. |
Fixed and overhauled in https://gitlab.com/gitlab-org/gitlab-ce/issues/51675. See MRs: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/25444, and https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/9640. |
ci/caching |
Describes caching within CI/CD. Currently classified as "Advanced Usage" on landing page. |
To be reviewed. |
ci/chatops |
Documents GitLab ChatOps. Currently classified as "Advanced Usage" on landing page. |
To be reviewed. |
ci/docker |
Section documents using Docker images, building Docker images, and kaniko. Called out separately on the landing page. |
To be reviewed. |
ci/interactive_web_terminal |
Documents web terminals for CI/CD pipelines. Currently classified as "Advanced Usage" on landing page. |
To be reviewed. |
ci/review_apps |
Documentation for Review Apps. Linked to from landing page, not categorized in terms of Essential, Basic, or Advanced on landing page. |
To be reviewed. |
ci/runners |
Runners documentation. Leans on documentation from gitlab-runners repository. Currently classified as "Basic Usage" on landing page. |
To be reviewed. |
ci/ssh_keys |
Standalone topic for using SSH keys with CI/CD. Currently classified as "Advanced Usage" on landing page. | To be reviewed. |
ci/triggers |
Documentation about configuring and executing pipeline triggers. Might be some duplication with Pipeline triggers API. Currently classified as "Advanced Usage" on landing page. |
To be reviewed. |
environments.md |
Long topic describing CI/CD environments. Currently classified as "Advanced Usage" on landing page. | To be reviewed. |
junit_test_reports.md |
Topic on producing JUnit test reports from a pipeline. Not linked from landing page, but examples page. |
To be reviewed. |
ci/autodeploy |
Content moved to Auto DevOps section. | N/A (content moved). |
ci/build_artifacts |
Content moved to user/project/pipelines/job_artifacts.md . |
N/A (content moved). |
ci/permissions |
Content moved to user/permissions.md . |
N/A (content moved). |
GitLab Repository (User Area)
Section path doc/user
|
Description | Scheduled actions |
---|---|---|
user/project/pipelines |
A section on CI/CD pipelines, presumably content relevant at the project level, rather than instance level. Not a lot of integration with pipelines.md in the ci area. |
Planned for overhaul in https://gitlab.com/gitlab-org/gitlab-ce/issues/58450. |
GitLab Repository (Topics Area)
Section path doc/topics
|
Description | Scheduled actions |
---|---|---|
topics/autodevops |
Section related to everything Auto DevOps. Called out separately on landing page. | Planned for overhaul in https://gitlab.com/gitlab-org/gitlab-ce/issues/58451. |
Edited by Evan Read