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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
# The syntax to use for patterns in the Rules file. Can be either `"glob"`
# (default) or `"legacy"`. The former will enable glob patterns, which behave
# like Ruby’s File.fnmatch. The latter will enable Nanoc 3.x-style patterns.
string_pattern_type: glob
# A list of file extensions that Nanoc will consider to be textual rather than
# binary. If an item with an extension not in this list is found, the file
# will be considered as binary.
text_extensions: [ 'adoc', 'asciidoc', 'atom', 'coffee', 'css', 'erb', 'haml', 'handlebars', 'hb', 'htm', 'html', 'js', 'less', 'markdown', 'md', 'ms', 'mustache', 'php', 'rb', 'rdoc', 'sass', 'scss', 'slim', 'txt', 'xhtml', 'xml' ]
# The path to the directory where all generated files will be written to. This
# can be an absolute path starting with a slash, but it can also be path
# relative to the site directory.
output_dir: public
# The path where the content files reside.
content_dir: content
# A list of index filenames, i.e. names of files that will be served by a web
# server when a directory is requested. Usually, index files are named
# “index.html”, but depending on the web server, this may be something else,
# such as “default.htm”. This list is used by Nanoc to generate pretty URLs.
index_filenames: [ 'index.html' ]
# Whether or not to generate a diff of the compiled content when compiling a
# site. The diff will contain the differences between the compiled content
# before and after the last site compilation.
enable_output_diff: false
domain: docs.gitlab.com
base_url: https://docs.gitlab.com
prune:
# Whether to automatically remove files not managed by Nanoc from the output
# directory.
auto_prune: true
# Which files and directories you want to exclude from pruning. If you version
# your output directory, you should probably exclude VCS directories such as
# .git, .svn etc.
exclude: [ '.git', '.hg', '.svn', 'CVS' ]
# The data sources where Nanoc loads its data from. This is an array of
# hashes; each array element represents a single data source. By default,
# there is only a single data source that reads data from the “content/” and
# “layout/” directories in the site directory.
data_sources:
-
# The type is the identifier of the data source.
type: filesystem
# The path where items should be mounted (comparable to mount points in
# Unix-like systems). This is “/” by default, meaning that items will have
# “/” prefixed to their identifiers. If the items root were “/en/”
# instead, an item at content/about.html would have an identifier of
# “/en/about/” instead of just “/about/”.
items_root: /
# The path where layouts should be mounted. The layouts root behaves the
# same as the items root, but applies to layouts rather than items.
layouts_root: /
# The encoding to use for input files. If your input files are not in
# UTF-8 (which they should be!), change this.
encoding: utf-8
# The kind of identifier to use for items and layouts. The default is
# “full”, meaning that identifiers include file extensions. This can also
# be “legacy”, primarily used by older Nanoc sites.
identifier_type: full
# Configuration for the “check” command, which run unit tests on the site.
checks:
# Configuration for the “internal_links” checker, which checks whether all
# internal links are valid.
internal_links:
# A list of patterns, specified as regular expressions, to exclude from the check.
# If an internal link matches this pattern, the validity check will be skipped.
exclude:
# Exclude major.minor versions that are used under /archives
- '^/\d{1,2}\.\d{1,2}/'
# The versions dropdown for the archives is incorrect. Remove this
# when fixed.
- '\/archives.html'
# Configuration for the “external_links” checker, which checks whether all
# external links are valid.
external_links:
# A list of patterns, specified as regular expressions, to exclude from the check.
# If an external link matches this pattern, the validity check will be skipped.
exclude:
# Valid links incorrectly reported as broken
- 'https:\/\/gitlab.com\/api\/v4\/.*'
- 'https:\/\/www\.linkedin\.com\/company\/gitlab-com'
- 'https:\/\/auth0\.com\/auth\/login'
- 'https:\/\/gitlab-org\.gitlab\.io\/gitlab-svgs'
- 'https:\/\/dl\.acm\.org\/citation\.cfm\?id=361591'
- 'https:\/\/pgp\.mit\.edu\/pks\/lookup\?op=vindex\&search=.*'
- 'https:\/\/www\.amazon\.com\/.*'
- 'https:\/\/contributors\.gitlab\.com\/'
- 'https:\/\/downloads\.raspberrypi\.org\/raspbian\/images\/'
- 'https:\/\/wiki\.jenkins\.io\/display\/JENKINS\/'
# Redirected links to ignore
- 'https:\/\/www\.jaegertracing\.io\/docs\/latest\/'
# Don't check links matching the following patterns
- 'https?:\/\/\w*\.example\.com.*'
- 'https?:\/\/localhost.*'
- 'https?:\/\/127.0.0.1.*'
# Don't check gitlab.com links due to cloudflare thinking the link test is a dos attack
# Temporary solution to enable external link checker
- 'https:\/\/gitlab.com\/.*'
# Don't check github.com links due to GitHub rate limiting causing 429 errors
# Temporary solution to enable external link checker
- 'https:\/\/github.com\/.*'
# A list of file patterns, specified as regular expressions, to exclude from the check.
# If a file matches this pattern, the links from this file will not be checked.
# E.g.:
# exclude_files: ['blog/page']
exclude_files: []
# Whether or not breadcrumbs are enabled.
# Breadcrumbs are enabled.
breadcrumbs: true
# Debug problems with the generation process by setting this config variable.
debug: false
products:
ee:
full_name: 'GitLab'
short_name: 'GitLab'
slug: 'ee'
index_file: 'README.*'
img: '/assets/images/docs-gitlab.svg'
description: 'Install, use, and administer GitLab self-managed and GitLab.com.'
repo: 'https://gitlab.com/gitlab-org/gitlab.git'
dirs:
temp_dir: 'tmp/ee/'
dest_dir: 'content/ee'
doc_dir: 'doc'
expose: true
icon: 'tanuki'
omnibus:
full_name: 'Omnibus GitLab'
short_name: 'Omnibus'
slug: 'omnibus'
index_file: 'README.*'
img: '/assets/images/docs-omnibus.svg'
description: 'Default GitLab installer. Full-stack, platform-specific packages. The most common way to install and configure GitLab.'
repo: 'https://gitlab.com/gitlab-org/omnibus-gitlab.git'
dirs:
temp_dir: 'tmp/omnibus/'
dest_dir: 'content/omnibus'
doc_dir: 'doc'
expose: true
icon: 'car'
runner:
full_name: 'GitLab Runner'
short_name: 'Runner'
slug: 'runner'
index_file: 'index.*'
img: '/assets/images/docs-runner.svg'
description: 'Agent for GitLab CI. Configure and run build scripts and other jobs as part of GitLab Continuous Integration & Deployment (CI/CD).'
repo: 'https://gitlab.com/gitlab-org/gitlab-runner.git'
dirs:
temp_dir: 'tmp/runner/'
dest_dir: 'content/runner'
doc_dir: 'docs'
expose: true
icon: 'status'
charts:
full_name: 'GitLab Helm chart'
short_name: 'Charts'
slug: 'charts'
index_file: 'index.*'
img: '/assets/images/docs-charts.svg'
description: 'Deploy GitLab to Kubernetes using the GitLab Helm Charts.'
repo: 'https://gitlab.com/gitlab-org/charts/gitlab.git'
dirs:
temp_dir: 'tmp/charts/'
dest_dir: 'content/charts'
doc_dir: 'doc'
expose: true
icon: 'chart'
|
