Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-10-13 09:09:37 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-10-13 09:09:37 +0300
commit95ce32c508b9d6c9bda443f0762b92ec71074777 (patch)
tree4215023739b3bee8daca346d8606ca9daf914fc8 /tooling
parent44696847f6f67ecd065d273f971a3aeec3187673 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'tooling')
-rw-r--r--tooling/audit_events/docs/templates/audit_event_types.md.erb26
1 files changed, 21 insertions, 5 deletions
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 429d341f9a6..40f015b8f55 100644
--- a/tooling/audit_events/docs/templates/audit_event_types.md.erb
+++ b/tooling/audit_events/docs/templates/audit_event_types.md.erb
@@ -1,4 +1,4 @@
-<% all_audit_event_types = Gitlab::Audit::Type::Definition.definitions.map(&:last) %>
+<% audit_event_types_by_feature_category = Gitlab::Audit::Type::Definition.definitions.map(&:last).group_by(&:feature_category) %>
<% def boolean_to_docs(boolean) %>
<% if boolean %>
<% "**{check-circle}** Yes" %>
@@ -6,6 +6,16 @@
<% "**{dotted-circle}** No" %>
<% end %>
<% end %>
+<% def humanize(feature_category) %>
+<% case feature_category %>
+<% when 'mlops' %>
+<% "MLOps" %>
+<% when 'not_owned' %>
+<% "Not categorized" %>
+<% else %>
+<% "#{feature_category.humanize}" %>
+<% end %>
+<% end %>
---
stage: Govern
group: Compliance
@@ -18,7 +28,7 @@ info: "See the Technical Writers assigned to Development Guidelines: https://abo
Please do not edit this file directly. To update this file, run:
bundle exec rake gitlab:audit_event_types:compile_docs
- To make changes to the output of the rake task,
+ To make changes to the output of the Rake task,
edit `tooling/audit_events/docs/templates/audit_event_types.md.erb`.
--->
@@ -38,7 +48,13 @@ audit events to external destinations.
## Available audit event types
-| Name | Description | Saved to database | Streamed | Feature category | Introduced in |
-|:-----|:------------|:------------------|:---------|:-----------------|:--------------|
-<% all_audit_event_types.each do |event_type| %>| <%= "[`#{event_type.name}`](#{event_type.introduced_by_mr})" %> | <%= event_type.description %> | <%= boolean_to_docs(event_type.saved_to_database) %> | <%= boolean_to_docs(event_type.streamed) %> | <%= "`#{event_type.feature_category}`" %> | GitLab <%= "[#{event_type.milestone}](#{event_type.introduced_by_issue})" %> |
+Audit event types belong to the following product categories.
+<% audit_event_types_by_feature_category.sort.each do |category, audit_event_types| %>
+
+### <%= "#{humanize(category)}" %>
+
+| Name | Description | Saved to database | Streamed | Introduced in |
+|:-----|:------------|:------------------|:---------|:--------------|
+<% audit_event_types.each do |event_type| %>| <%= "[`#{event_type.name}`](#{event_type.introduced_by_mr})" %> | <%= event_type.description %>| <%= boolean_to_docs(event_type.saved_to_database) %> | <%= boolean_to_docs(event_type.streamed) %> | GitLab <%= "[#{event_type.milestone}](#{event_type.introduced_by_issue})" %> |
+<% end %>
<% end %>