From 8d48a5a706236197cfe90bf4b45a0612fff229e0 Mon Sep 17 00:00:00 2001
From: Evan Read <eread@gitlab.com>
Date: Wed, 7 Feb 2024 23:31:27 +0000
Subject: [PATCH] Fix the comments in auto-generated documentation
This allows our linters to properly ignore the content within them.
---
doc/administration/audit_event_types.md | 4 ++--
doc/api/graphql/reference/index.md | 4 ++--
doc/development/documentation/redirects.md | 4 ++--
doc/user/custom_roles/abilities.md | 6 +++---
.../audit_events/docs/templates/audit_event_types.md.erb | 4 ++--
tooling/custom_roles/docs/templates/custom_abilities.md.erb | 4 ++--
tooling/graphql/docs/helper.rb | 4 ++--
7 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/doc/administration/audit_event_types.md b/doc/administration/audit_event_types.md
index 86d8e9e17061..425219672c3a 100644
--- a/doc/administration/audit_event_types.md
+++ b/doc/administration/audit_event_types.md
@@ -4,7 +4,7 @@ group: Compliance
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments"
---
-<!---
+<!--
This documentation is auto generated by a Rake task.
Please do not edit this file directly. To update this file, run:
@@ -12,7 +12,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated
To make changes to the output of the Rake task,
edit `tooling/audit_events/docs/templates/audit_event_types.md.erb`.
---->
+-->
# Audit event types
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md
index 5a62f47d76e9..b09b66cf8f9c 100644
--- a/doc/api/graphql/reference/index.md
+++ b/doc/api/graphql/reference/index.md
@@ -4,11 +4,11 @@ group: Import and Integrate
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
---
-<!---
+<!--
This documentation is auto generated by a script.
Please do not edit this file directly, check compile_docs task on lib/tasks/gitlab/graphql.rake.
---->
+-->
# GraphQL API resources
diff --git a/doc/development/documentation/redirects.md b/doc/development/documentation/redirects.md
index 056ef9d3d62c..76f97d5ddd1b 100644
--- a/doc/development/documentation/redirects.md
+++ b/doc/development/documentation/redirects.md
@@ -5,13 +5,13 @@ info: For assistance with this Style Guide page, see https://handbook.gitlab.com
description: Learn how to contribute to GitLab Documentation.
---
-<!---
+<!--
The clean_redirects Rake task in the gitlab-docs repository manually
excludes this file. If the line containing remove_date is moved to a new
document, update the Rake task with the new location.
https://gitlab.com/gitlab-org/gitlab-docs/-/blob/1979f985708d64558bb487fbe9ed5273729c01b7/Rakefile#L306
---->
+-->
# Redirects in GitLab documentation
diff --git a/doc/user/custom_roles/abilities.md b/doc/user/custom_roles/abilities.md
index 924275ae6ab6..18d7d08e7ba5 100644
--- a/doc/user/custom_roles/abilities.md
+++ b/doc/user/custom_roles/abilities.md
@@ -4,7 +4,7 @@ group: Authorization
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments"
---
-<!---
+<!--
This documentation is auto generated by a Rake task.
Please do not edit this file directly. To update this file, run:
@@ -12,7 +12,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated
To make changes to the output of the Rake task,
edit `tooling/custom_roles/docs/templates/custom_abilities.md.erb`.
---->
+-->
# Available custom permissions
@@ -60,6 +60,6 @@ These requirements are documented in the `Required permission` column in the fol
| Name | Required permission | Description | Introduced in | Feature flag | Enabled in |
|:-----|:------------|:------------------|:---------|:--------------|:---------|
-| [`admin_vulnerability`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121534) | read_vulnerability | Allows admin access to the vulnerability reports. | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/412536) | | |
+| [`admin_vulnerability`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/121534) | | Allows admin access to the vulnerability reports. | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/412536) | | |
| [`read_dependency`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/126247) | | Allows read-only access to the dependencies. | GitLab [16.3](https://gitlab.com/gitlab-org/gitlab/-/issues/415255) | | |
| [`read_vulnerability`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120704) | | Allows read-only access to the vulnerability reports. | GitLab [16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/399119) | | |
diff --git a/tooling/audit_events/docs/templates/audit_event_types.md.erb b/tooling/audit_events/docs/templates/audit_event_types.md.erb
index b12416750fe1..31f06c06b76c 100644
--- a/tooling/audit_events/docs/templates/audit_event_types.md.erb
+++ b/tooling/audit_events/docs/templates/audit_event_types.md.erb
@@ -22,7 +22,7 @@ group: Compliance
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments"
---
-<!---
+<!--
This documentation is auto generated by a Rake task.
Please do not edit this file directly. To update this file, run:
@@ -30,7 +30,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated
To make changes to the output of the Rake task,
edit `tooling/audit_events/docs/templates/audit_event_types.md.erb`.
---->
+-->
# Audit event types
diff --git a/tooling/custom_roles/docs/templates/custom_abilities.md.erb b/tooling/custom_roles/docs/templates/custom_abilities.md.erb
index 9d29cf3333fa..d58143162617 100644
--- a/tooling/custom_roles/docs/templates/custom_abilities.md.erb
+++ b/tooling/custom_roles/docs/templates/custom_abilities.md.erb
@@ -24,7 +24,7 @@ group: Authorization
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments"
---
-<!---
+<!--
This documentation is auto generated by a Rake task.
Please do not edit this file directly. To update this file, run:
@@ -32,7 +32,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated
To make changes to the output of the Rake task,
edit `tooling/custom_roles/docs/templates/custom_abilities.md.erb`.
---->
+-->
# Available custom permissions
diff --git a/tooling/graphql/docs/helper.rb b/tooling/graphql/docs/helper.rb
index d027c5b35db2..3798101e7ce8 100644
--- a/tooling/graphql/docs/helper.rb
+++ b/tooling/graphql/docs/helper.rb
@@ -60,11 +60,11 @@ def auto_generated_comment
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
---
- <!---
+ <!--
This documentation is auto generated by a script.
Please do not edit this file directly, check compile_docs task on lib/tasks/gitlab/graphql.rake.
- --->
+ -->
MD
end
--
GitLab