Remove comments and slightly reformat nanoc config file

1 files changed, 36 insertions, 79 deletions

diff --git a/nanoc.yaml b/nanoc.yaml
index 75449972..9bd28d12 100644
--- a/nanoc.yaml
+++ b/nanoc.yaml
@@ -1,82 +1,54 @@
-# 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.
+# For a list of configuration options, see https://nanoc.ws/doc/reference/config/
 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.
+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']
 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.
+index_filenames: ['index.html']
 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
+  exclude: ['.git', '.hg', '.svn', 'CVS']
 
-  # 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}/'
@@ -84,11 +56,7 @@ checks:
       # 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\/.*'
@@ -119,23 +87,12 @@ checks:
       # Some links require authentication, but we want to keep them in development docs
       - 'https:\/\/dashboards.gitlab.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: false
 
-# Whether to show the banner defined in layouts/banner.html.
-# Set to true or false.
+# Control display of survey banner. See README.md#survey-banner
 show_banner: false
 
-# Debug problems with the generation process by setting this config variable.
-debug: false
-
 products:
   ee:
     full_name: 'GitLab'
@@ -148,7 +105,7 @@ products:
     dirs:
       temp_dir: 'tmp/ee/'
       dest_dir: 'content/ee'
-      doc_dir:  'doc'
+      doc_dir: 'doc'
     expose: true
     icon: 'tanuki'
   runner:
@@ -162,7 +119,7 @@ products:
     dirs:
       temp_dir: 'tmp/runner/'
       dest_dir: 'content/runner'
-      doc_dir:  'docs'
+      doc_dir: 'docs'
     expose: true
     icon: 'status'
   omnibus:
@@ -176,7 +133,7 @@ products:
     dirs:
       temp_dir: 'tmp/omnibus/'
       dest_dir: 'content/omnibus'
-      doc_dir:  'doc'
+      doc_dir: 'doc'
     expose: true
     icon: 'car'
   charts:
@@ -190,6 +147,6 @@ products:
     dirs:
       temp_dir: 'tmp/charts/'
       dest_dir: 'content/charts'
-      doc_dir:  'doc'
+      doc_dir: 'doc'
     expose: true
     icon: 'chart'