From c43911c5959734f1b13a5d09ef759bf7e1a1462a Mon Sep 17 00:00:00 2001 From: Marcel Amirault <mamirault@gitlab.com> Date: Tue, 4 Mar 2025 05:01:36 +0000 Subject: [PATCH] Update codeowners for TW team Files that can affect docs builds should be listed as requiring optional TW approval, to include TW team when needed --- .gitlab/CODEOWNERS | 40 +++++++++++++++---------- doc/development/contributing/_index.md | 2 +- doc/development/documentation/_index.md | 4 +-- lib/tasks/gitlab/tw/codeowners.rake | 2 +- 4 files changed, 29 insertions(+), 19 deletions(-) diff --git a/.gitlab/CODEOWNERS b/.gitlab/CODEOWNERS index d37a14e2c580b..bc9aedb0c8a60 100644 --- a/.gitlab/CODEOWNERS +++ b/.gitlab/CODEOWNERS @@ -30,13 +30,14 @@ ## Technical writing files that do not need `*` rule approval, ## but still require an approval from a TW team DRI for each file. -/data/deprecations/templates/ @marcel.amirault @sarahgerman @gitlab-org/tw-leadership .markdownlint-cli2.yaml @marcel.amirault @eread @aqualls @gitlab-org/tw-leadership +/data/deprecations/templates/ @marcel.amirault @gitlab-org/tw-leadership /doc/.markdownlint/ @marcel.amirault @eread @aqualls @gitlab-org/tw-leadership /doc/.vale/ @marcel.amirault @eread @aqualls @gitlab-org/tw-leadership -/lib/tasks/gitlab/tw/codeowners.rake @aqualls @gitlab-org/tw-leadership -/scripts/lint-doc.sh @marcel.amirault @eread @axil @sarahgerman @gitlab-org/tw-leadership -/scripts/lint-docs-metadata.sh @marcel.amirault @eread @axil @sarahgerman @gitlab-org/tw-leadership +/lib/tasks/gitlab/tw/codeowners.rake @marcel.amirault @aqualls @gitlab-org/tw-leadership +/scripts/lint-doc.sh @marcel.amirault @eread @axil @gitlab-org/tw-leadership +/scripts/lint-docs-metadata.sh @marcel.amirault @eread @axil @gitlab-org/tw-leadership +/scripts/lint-docs-redirects.rb @marcel.amirault @eread @axil @gitlab-org/tw-leadership config/bounded_contexts.yml @fabiopitino @grzesiek @stanhu @cwoolley-gitlab @tkuah @@ -108,7 +109,7 @@ config/bounded_contexts.yml @fabiopitino @grzesiek @stanhu @cwoolley-gitlab @tku [Pipeline configuration] @gl-dx/pipeline-maintainers /.gitlab-ci.yml /.gitlab/ci/ -/.gitlab/ci/docs.gitlab-ci.yml @gl-dx/pipeline-maintainers @gl-docsteam +/.gitlab/ci/docs.gitlab-ci.yml @gl-dx/pipeline-maintainers @marcel.amirault @axil @eread @gitlab-org/tw-leadership /.gitlab/ci/frontend.gitlab-ci.yml @gl-dx/pipeline-maintainers @gitlab-org/maintainers/frontend /.gitlab/ci/test-on-omnibus/ @gl-dx/pipeline-maintainers @gl-dx/maintainers /.gitlab/ci/qa.gitlab-ci.yml @gl-dx/pipeline-maintainers @gl-dx/maintainers @@ -555,19 +556,27 @@ ee/lib/ee/gitlab/git_access_*.rb ee/lib/ee/gitlab/checks/** lib/gitlab/checks/** -^[Documentation Directories] @gl-docsteam +^[Technical writing] @marcel.amirault @eread @axil @gitlab-org/tw-leadership +/.gitlab/ci/docs.gitlab-ci.yaml +/lib/tasks/gitlab/docs/ +/rubocop/cop/gitlab/documentation_links/ +/scripts/frontend/lint_docs_links.mjs +/scripts/lint/check_mermaid.mjs +/tooling/audit_events/docs/ +/tooling/ci/job_tokens/docs/ +/tooling/custom_roles/docs/ +/tooling/eslint-config/eslint-local-rules/require_valid_help_page_path.js +/tooling/graphql/docs/ + +^[Documentation Pages] @gl-docsteam /doc/ /data/deprecations/ - -^[Documentation Pages] # This block is managed by the rake script at lib/tasks/gitlab/tw/codeowners.rake, manual updates will be overwritten! # Begin rake-managed-docs-block /doc/administration/_index.md @axil /doc/administration/analytics.md @lciutacu /doc/administration/analytics/ @lciutacu /doc/administration/application_settings_cache.md @jglassman1 -/doc/administration/audit_event_reports.md @eread -/doc/administration/audit_event_streaming/ @eread /doc/administration/auditor_users.md @idurham /doc/administration/auth/ @idurham /doc/administration/backup_restore/ @axil @@ -576,7 +585,7 @@ lib/gitlab/checks/** /doc/administration/cicd/ @lyspin /doc/administration/cicd/job_logs.md @rsarangadharan /doc/administration/clusters/ @z_painter -/doc/administration/compliance.md @eread +/doc/administration/compliance/ @eread /doc/administration/configure.md @axil /doc/administration/consul.md @axil /doc/administration/credentials_inventory.md @idurham @@ -647,7 +656,9 @@ lib/gitlab/checks/** /doc/administration/raketasks/ @axil /doc/administration/raketasks/ldap.md @idurham /doc/administration/raketasks/praefect.md @eread +/doc/administration/raketasks/spdx.md @rdickenson /doc/administration/raketasks/tokens/ @idurham +/doc/administration/raketasks/x509_signatures.md @brendan777 /doc/administration/read_only_gitlab.md @axil /doc/administration/redis/ @axil /doc/administration/reference_architectures/ @axil @@ -922,6 +933,7 @@ lib/gitlab/checks/** /doc/ci/gitlab_google_cloud_integration/ @lyspin /doc/ci/interactive_web_terminal/ @rsarangadharan /doc/ci/jobs/ @marcel.amirault +/doc/ci/jobs/fine_grained_permissions.md @idurham /doc/ci/jobs/job_artifacts.md @lyspin /doc/ci/jobs/job_artifacts_troubleshooting.md @lyspin /doc/ci/jobs/job_logs.md @lyspin @@ -954,6 +966,7 @@ lib/gitlab/checks/** /doc/ci/yaml/ @marcel.amirault /doc/ci/yaml/artifacts_reports.md @lyspin /doc/development/advanced_search.md @gitlab-org/search-team/migration-maintainers +/doc/development/advanced_search/ @gitlab-org/search-team/migration-maintainers /doc/development/ai_architecture.md @gitlab-org/ai-powered /doc/development/ai_features/ @gitlab-org/ai-powered /doc/development/ai_features/embeddings.md @gitlab-org/search-team/migration-maintainers @@ -968,7 +981,7 @@ lib/gitlab/checks/** /doc/development/database/ @OmarQunsulGitlab @bmarjanovic /doc/development/distributed_tracing.md @gitlab-org/analytics-section/product-analytics/engineers/frontend /doc/development/distribution/ @gitlab-org/distribution -/doc/development/documentation/ @fneill +/doc/development/documentation/ @fneill @sselhorn /doc/development/duo_workflow/ @gitlab-org/ai-powered /doc/development/fe_guide/analytics_dashboards.md @gitlab-org/analytics-section/product-analytics/engineers/frontend /doc/development/fe_guide/keyboard_shortcuts.md @gitlab-org/foundations/engineering @@ -1022,9 +1035,6 @@ lib/gitlab/checks/** /doc/operations/ @lciutacu /doc/operations/feature_flags.md @z_painter /doc/policy/ @axil -/doc/raketasks/ @axil -/doc/raketasks/spdx.md @rdickenson -/doc/raketasks/x509_signatures.md @brendan777 /doc/security/ @idurham /doc/security/hardening_nist_800_53.md @emily.sahlani /doc/solutions/ @jfullam @Darwinjs @sbrightwell diff --git a/doc/development/contributing/_index.md b/doc/development/contributing/_index.md index 48ab0848ee2b3..476ed6e764495 100644 --- a/doc/development/contributing/_index.md +++ b/doc/development/contributing/_index.md @@ -54,7 +54,7 @@ and filter specifically for [documentation `~quick win`](https://gitlab.com/grou or [frontend `~quick win`](https://gitlab.com/groups/gitlab-org/-/issues/?sort=created_asc&state=opened&label_name%5B%5D=quick%20win&label_name%5B%5D=frontend&first_page_size=100). When you find an issue you want to work on, leave a comment on it. -This helps the GitLab team and members of the wider GitLab community know that you will be working on that issue. +This helps the GitLab team and members of the wider GitLab community know that you are working on that issue. This is a good opportunity to [validate the issue](issue_workflow.md#clarifyingvalidating-an-issue). Confirm that the issue is still valid, clarify your intended approach, and ask if a feature or change is likely to be accepted. diff --git a/doc/development/documentation/_index.md b/doc/development/documentation/_index.md index 611859df28906..7354fce9c13c6 100644 --- a/doc/development/documentation/_index.md +++ b/doc/development/documentation/_index.md @@ -17,8 +17,8 @@ Prerequisites: - [Request access to the GitLab community fork](https://gitlab.com/groups/gitlab-community/community-members/-/group_members/request_access). The community fork is a shared copy of the main GitLab repository. - When you make the request, you'll be asked to answer a few questions. Let them know - that you're interested in contributing to the GitLab documentation. + When you make the request, you'll be asked to answer a few questions. Let them know + that you're interested in contributing to the GitLab documentation. To update the documentation: diff --git a/lib/tasks/gitlab/tw/codeowners.rake b/lib/tasks/gitlab/tw/codeowners.rake index 4869288a612c0..38d1ffc2ef5c0 100644 --- a/lib/tasks/gitlab/tw/codeowners.rake +++ b/lib/tasks/gitlab/tw/codeowners.rake @@ -105,7 +105,7 @@ namespace :tw do CodeOwnerRule.new('Composition Analysis', '@gitlab-org/secure/composition-analysis-be @gitlab-org/secure/static-analysis'), CodeOwnerRule.new('Distribution', '@gitlab-org/distribution'), - CodeOwnerRule.new('Documentation Guidelines', '@fneill'), + CodeOwnerRule.new('Documentation Guidelines', '@fneill @sselhorn'), CodeOwnerRule.new('Duo Workflow', '@gitlab-org/ai-powered'), CodeOwnerRule.new('Engineering Productivity', '@gl-dx/eng-prod'), CodeOwnerRule.new('Personal Productivity', '@gitlab-org/foundations/engineering'), -- GitLab