blob: 1dc660e574bda23f296f2f2e897b34503d84f22e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
# frozen_string_literal: true
module Gitlab
module Usage
module Docs
# Helper with functions to be used by HAML templates
module Helper
def auto_generated_comment
<<-MARKDOWN.strip_heredoc
---
stage: Growth
group: Product Intelligence
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
---
<!---
This documentation is auto generated by a script.
Please do not edit this file directly, check generate_metrics_dictionary task on lib/tasks/gitlab/usage_data.rake.
--->
<!-- vale gitlab.Spelling = NO -->
MARKDOWN
end
def render_name(name)
"### `#{name}`"
end
def render_description(object)
return 'Missing description' unless object[:description].present?
object[:description]
end
def render_yaml_link(yaml_path)
"[YAML definition](#{yaml_path})"
end
def render_status(object)
"Status: #{format(:status, object[:status])}"
end
def render_owner(object)
"Group: `#{object[:product_group]}`"
end
def render_tiers(object)
"Tiers:#{format(:tier, object[:tier])}"
end
def format(key, value)
Gitlab::Usage::Docs::ValueFormatter.format(key, value)
end
end
end
end
end
|
