Update group assignments for CI docs
What does this MR do?
This MR is to update the documentation assignments for the Verify stage. See related issues for more details.
The main changes are:
- Pipeline Insights renamed to Pipeline Security
-
Secrets Management
category moved to Pipeline Security -
Code Testing and Coverage
category moved to Pipeline Execution -
Review Apps
category moved to Pipeline Execution - Variables feature moved to Pipeline Security
Related issues
- Related to https://gitlab.com/gitlab-com/Product/-/issues/5470
- Related to gitlab-com/www-gitlab-com!120184 (merged)
- Related to gitlab-com/www-gitlab-com!120068 (merged)
- Related to technical-writing#759 (closed)
Full list of changes
Doc | Title | Current Group | Changed to | Notes |
---|---|---|---|---|
doc/administration/cicd.md |
GitLab CI/CD instance configuration | Pipeline Execution | ||
doc/administration/external_pipeline_validation.md |
External pipeline validation | Pipeline Execution | ||
doc/administration/job_artifacts.md |
Jobs artifacts administration | Pipeline Security | Pipeline Execution | |
doc/api/group_level_variables.md |
Group-level Variables API | Pipeline Authoring | Pipeline Security | |
doc/api/instance_level_ci_variables.md |
Instance-level CI/CD variables API | Pipeline Authoring | Pipeline Security | |
doc/api/job_artifacts.md |
Job Artifacts API | Pipeline Security | ||
doc/api/jobs.md |
Jobs API | Pipeline Execution | ||
doc/api/lint.md |
CI Lint API | Pipeline Authoring | ||
doc/api/merge_trains.md |
Merge Trains API | Pipeline Execution | ||
doc/api/pipeline_schedules.md |
Pipeline schedules API | Pipeline Execution | ||
doc/api/pipeline_triggers.md |
Pipeline trigger tokens API | Pipeline Execution | ||
doc/api/pipelines.md |
Pipelines API | Pipeline Execution | ||
doc/api/project_level_variables.md |
Project-level CI/CD variables API | Pipeline Authoring | Pipeline Security | |
doc/api/secure_files.md |
Project-level Secure Files API | Pipeline Authoring | Pipeline Security | Seems to fall under PS's new responsibilities |
doc/api/templates/gitlab_ci_ymls.md |
GitLab CI YAML API | Pipeline Authoring | ||
doc/api/visual_review_discussions.md |
Visual Review discussions API | Pipeline Security | Pipeline Execution | Review App related |
doc/ci/caching/index.md |
Caching in GitLab CI/CD | Pipeline Authoring | ||
doc/ci/ci_cd_for_external_repos/bitbucket_integration.md |
Using GitLab CI/CD with a Bitbucket Cloud repository | Pipeline Execution | ||
doc/ci/ci_cd_for_external_repos/github_integration.md |
Using GitLab CI/CD with a GitHub repository | Pipeline Execution | ||
doc/ci/ci_cd_for_external_repos/index.md |
GitLab CI/CD for external repositories | Pipeline Execution | ||
doc/ci/cloud_services/aws/index.md |
Configure OpenID Connect in AWS to retrieve temporary credentials | Pipeline Authoring | Pipeline Security | |
doc/ci/cloud_services/azure/index.md |
Configure OpenID Connect in Azure to retrieve temporary credentials | Pipeline Authoring | Pipeline Security | |
doc/ci/cloud_services/google_cloud/index.md |
Configure OpenID Connect with GCP Workload Identity Federation | Pipeline Authoring | Pipeline Security | |
doc/ci/cloud_services/index.md |
Connect to cloud services | Pipeline Authoring | Pipeline Security | |
doc/ci/directed_acyclic_graph/index.md |
Directed Acyclic Graph | Pipeline Authoring | ||
doc/ci/docker/index.md |
Docker integration | Pipeline Execution | ||
doc/ci/docker/using_docker_build.md |
Use Docker to build Docker images | Pipeline Execution | ||
doc/ci/docker/using_kaniko.md |
Use kaniko to build Docker images | Pipeline Execution | ||
doc/ci/enable_or_disable_ci.md |
Disabling GitLab CI/CD | Pipeline Execution | ||
doc/ci/examples/authenticating-with-hashicorp-vault/index.md |
Authenticating and reading secrets with HashiCorp Vault | Pipeline Authoring | Pipeline Security | |
doc/ci/examples/end_to_end_testing_webdriverio/index.md |
End-to-end testing with GitLab CI/CD and WebdriverIO | Pipeline Security | Pipeline Execution | Related to code testing |
doc/ci/examples/index.md |
GitLab CI/CD Examples | Pipeline Execution | ||
doc/ci/examples/laravel_with_gitlab_and_envoy/index.md |
Test and deploy Laravel applications with GitLab CI/CD and Envoy | Pipeline Execution | ||
doc/ci/examples/php.md |
Testing PHP projects | Pipeline Execution | ||
doc/ci/git_submodules.md |
Using Git submodules with GitLab CI/CD | Pipeline Execution | ||
doc/ci/index.md |
GitLab CI/CD | Pipeline Execution | ||
doc/ci/introduction/index.md |
CI/CD concepts | Pipeline Execution | Pipeline Authoring | This is targeting new pipeline authors |
doc/ci/jobs/ci_job_token.md |
GitLab CI/CD job token | Pipeline Execution | Pipeline Security | |
doc/ci/jobs/index.md |
Jobs | Pipeline Execution | Pipeline Authoring | This is targeting new pipeline authors |
doc/ci/jobs/job_control.md |
Choose when to run jobs | Pipeline Authoring | ||
doc/ci/lint.md |
Validate GitLab CI/CD configuration | Pipeline Authoring | ||
doc/ci/migration/circleci.md |
Migrating from CircleCI | Pipeline Authoring | ||
doc/ci/migration/jenkins.md |
Migrating from Jenkins | Pipeline Authoring | ||
doc/ci/pipeline_editor/index.md |
Pipeline Editor | Pipeline Authoring | ||
doc/ci/pipelines/cicd_minutes.md |
CI/CD minutes quota | Pipeline Execution | ||
doc/ci/pipelines/downstream_pipelines.md |
Downstream pipelines | Pipeline Authoring | ||
doc/ci/pipelines/index.md |
CI/CD pipelines | Pipeline Authoring | ||
doc/ci/pipelines/job_artifacts.md |
Job artifacts | Pipeline Security | ||
doc/ci/pipelines/merge_request_pipelines.md |
Merge request pipelines | Pipeline Execution | ||
doc/ci/pipelines/merge_trains.md |
Merge trains | Pipeline Execution | ||
doc/ci/pipelines/merged_results_pipelines.md |
Merged results pipelines | Pipeline Execution | ||
doc/ci/pipelines/pipeline_architectures.md |
Pipeline architecture | Pipeline Execution | Pipeline Authoring | This is targeting new pipeline authors |
doc/ci/pipelines/pipeline_artifacts.md |
Pipeline artifacts | Pipeline Security | ||
doc/ci/pipelines/pipeline_efficiency.md |
Pipeline efficiency | Pipeline Execution | ||
doc/ci/pipelines/schedules.md |
Scheduled pipelines | Pipeline Execution | ||
doc/ci/pipelines/settings.md |
Customize pipeline configuration | Pipeline Execution | ||
doc/ci/quick_start/index.md |
Tutorial: Create and run your first GitLab CI/CD pipeline | Pipeline Authoring | ||
doc/ci/review_apps/index.md |
Review apps | Pipeline Security | Pipeline Execution | |
doc/ci/secrets/id_token_authentication.md |
OpenID Connect (OIDC) Authentication Using ID Tokens | Pipeline Authoring | Pipeline Security | |
doc/ci/secrets/index.md |
Using external secrets in CI | Pipeline Authoring | ||
doc/ci/secure_files/index.md |
Project-level Secure Files | Pipeline Authoring | Pipeline Security | Seems to fall under PS's new responsibilities |
doc/ci/ssh_keys/index.md |
Using SSH keys with GitLab CI/CD | Pipeline Execution | Pipeline Security | Seems to fall under PS's new responsibilities |
doc/ci/testing/accessibility_testing.md |
Accessibility testing | Pipeline Security | Pipeline Execution | |
doc/ci/testing/browser_performance_testing.md |
Browser Performance Testing | Pipeline Security | Pipeline Execution | |
doc/ci/testing/fail_fast_testing.md |
Fail Fast Testing | Pipeline Security | Pipeline Execution | |
doc/ci/testing/index.md |
Test with GitLab CI/CD and generate reports in merge requests | Pipeline Security | Pipeline Execution | |
doc/ci/testing/load_performance_testing.md |
Load Performance Testing | Pipeline Security | Pipeline Execution | |
doc/ci/testing/metrics_reports.md |
Metrics Reports | Pipeline Security | Pipeline Execution | |
doc/ci/testing/test_coverage_visualization.md |
Test coverage visualization | Pipeline Security | Pipeline Execution | |
doc/ci/testing/unit_test_report_examples.md |
Unit test report examples | Pipeline Security | Pipeline Execution | |
doc/ci/testing/unit_test_reports.md |
Unit test reports | Pipeline Security | Pipeline Execution | |
doc/ci/triggers/index.md |
Trigger pipelines by using the API | Pipeline Execution | Pipeline Authoring | Recent work here around retrying triggers was led by Pipeline Authoring? PLEASE CHECK |
doc/ci/troubleshooting.md |
Troubleshooting CI/CD | Pipeline Execution | Pipeline Authoring | Seems more useful to pipeline authors |
doc/ci/variables/index.md |
GitLab CI/CD variables | Pipeline Authoring | Pipeline Security | |
doc/ci/variables/predefined_variables.md |
Predefined variables reference | Pipeline Authoring | Pipeline Security | |
doc/ci/variables/where_variables_can_be_used.md |
Where variables can be used | Pipeline Authoring | Pipeline Security | |
doc/ci/yaml/artifacts_reports.md |
GitLab CI/CD artifacts reports types | Pipeline Security | Pipeline Execution | Mostly about test/coverage reports |
doc/ci/yaml/gitlab_ci_yaml.md |
The .gitlab-ci.yml file |
Pipeline Authoring | ||
doc/ci/yaml/includes.md |
GitLab CI/CD include examples | Pipeline Authoring | ||
doc/ci/yaml/index.md |
.gitlab-ci.yml keyword reference |
Pipeline Authoring | ||
doc/ci/yaml/script.md |
Format scripts and job logs | Pipeline Authoring | ||
doc/ci/yaml/workflow.md |
GitLab CI/CD workflow keyword |
Pipeline Authoring | ||
doc/ci/yaml/yaml_optimization.md |
Optimize GitLab CI/CD configuration files | Pipeline Authoring | ||
doc/user/admin_area/settings/continuous_integration.md |
Continuous Integration and Deployment Admin Area settings | Pipeline Execution | ||
doc/user/admin_area/settings/rate_limit_on_pipelines_creation.md |
Rate limits on pipeline creation | Pipeline Execution | ||
doc/user/group/repositories_analytics/index.md |
Repositories analytics for groups | Pipeline Security | Pipeline Execution | Mostly about test/coverage reports |
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Marcel Amirault