cloudcannon.config.yml

paths:
  collections: content
collections_config:
  pages:
    parse_branch_index: true
    path: /
  standalone_pages:
    path: content/
    output: true
    parse_branch_index: false
    filter:
      base: strict
      include:
        - ossc.md
        - search.md
        - success.md
    name: Standalone Website Pages
    description: This collection contains standalone website pages like the search landing page.
    icon: notes
    sort_options:
      - key: weight
        order: ascending
    _editables: {}
    _inputs: {}
    _select_data: {}
    _structures: {}
    disable_add: true
    disable_add_folder: false
    disable_file_actions: false
    schemas: {}
  nginx_plus:
    path: content/nginx
    name: NGINX Plus
    description: Documentation for NGINX and NGINX Plus.
    output: true
    parse_branch_index: false
    icon: notes
    preview:
      metadata:
        - text:
            - key: path
          icon: folder
    _editables: {}
    _inputs: {}
    _select_data: {}
    _structures: {}
    create:
      path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]'
      extra_data: {}
      _inputs: {}
      _select_data: {}
      _structures: {}
    disable_add: false
    disable_add_folder: false
    disable_file_actions: false
    schemas:
      default:
        path: .cloudcannon/schemas/default.md
        reorder_inputs: true
        hide_extra_inputs: true
        remove_empty_inputs: false
        remove_extra_inputs: false
        name: Task (default)
        icon: task
        preview: {}
        _editables: {}
        _inputs: {}
        _select_data: {}
        _structures: {}
        create:
          path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]'
          extra_data: {}
          _inputs: {}
          _select_data: {}
          _structures: {}
      concept:
        path: .cloudcannon/schemas/concept.md
        reorder_inputs: true
        hide_extra_inputs: true
        remove_empty_inputs: false
        remove_extra_inputs: false
        name: Concept
        icon: lightbulb
        _editables: {}
        _inputs: {}
        _select_data: {}
        _structures: {}
  nap_dos:
    path: content/nap-dos
    output: true
    name: NGINX App Protect DoS
    description: Documentation for NGINX App Protect DoS
    parse_branch_index: false
    icon: notes
    preview:
      metadata:
        - text:
            - key: path
          icon: folder
    _editables: {}
    _inputs: {}
    _select_data: {}
    _structures: {}
    disable_add: false
    disable_add_folder: false
    disable_file_actions: false
    schemas:
      default:
        path: .cloudcannon/schemas/default.md
        reorder_inputs: true
        hide_extra_inputs: true
        remove_empty_inputs: false
        remove_extra_inputs: false
        name: Task (default)
        icon: task
        _editables: {}
        _inputs: {}
        _select_data: {}
        _structures: {}
      concept:
        path: .cloudcannon/schemas/concept.md
        reorder_inputs: true
        hide_extra_inputs: true
        remove_empty_inputs: false
        remove_extra_inputs: false
        name: Concept
        icon: lightbulb
        _editables: {}
        _inputs: {}
        _select_data: {}
        _structures: {}
  nap_waf:
    path: content/nap-waf
    output: true
    name: NGINX App Protect WAF
    description: Documentation for NGINX App Protect WAF.
    parse_branch_index: false
    icon: notes
    preview:
      metadata:
        - text:
            - key: path
          icon: folder
    _editables: {}
    _inputs: {}
    _select_data: {}
    _structures: {}
    create:
      path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]'
      extra_data: {}
      _inputs: {}
      _select_data: {}
      _structures: {}
    disable_add: false
    disable_add_folder: false
    disable_file_actions: false
    schemas:
      default:
        path: .cloudcannon/schemas/default.md
        reorder_inputs: true
        hide_extra_inputs: true
        remove_empty_inputs: false
        remove_extra_inputs: false
        name: Task (default)
        icon: task
        _editables: {}
        _inputs: {}
        _select_data: {}
        _structures: {}
      concept:
        path: .cloudcannon/schemas/concept.md
        reorder_inputs: true
        hide_extra_inputs: true
        remove_empty_inputs: false
        remove_extra_inputs: false
        name: Concept
        icon: lightbulb
        _editables: {}
        _inputs: {}
        _select_data: {}
        _structures: {}
  nms:
    path: content/nms
    output: true
    name: NGINX Management Suite
    description: Documentation for NGINX Management Suite.
    parse_branch_index: false
    icon: notes
    preview:
      metadata:
        - text:
            - key: path
          icon: folder
    _editables: {}
    _inputs: {}
    _select_data: {}
    _structures: {}
    create:
      path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]'
      extra_data: {}
      _inputs: {}
      _select_data: {}
      _structures: {}
    disable_add: false
    disable_add_folder: false
    disable_file_actions: false
    schemas:
      default:
        path: .cloudcannon/schemas/default.md
        reorder_inputs: true
        hide_extra_inputs: true
        remove_empty_inputs: false
        remove_extra_inputs: false
        name: Task (default)
        icon: task
        _editables: {}
        _inputs: {}
        _select_data: {}
        _structures: {}
      concept:
        path: .cloudcannon/schemas/concept.md
        reorder_inputs: true
        hide_extra_inputs: true
        remove_empty_inputs: false
        remove_extra_inputs: false
        name: Concept
        icon: lightbulb
        _editables: {}
        _inputs: {}
        _select_data: {}
        _structures: {}
      policy:
        path: .cloudcannon/schemas/nms/policy.md
        reorder_inputs: true
        hide_extra_inputs: true
        remove_empty_inputs: false
        remove_extra_inputs: false
        name: ACM Policy
        icon: table_chart
        _editables: {}
        _inputs: {}
        _select_data: {}
        _structures: {}
  controller:
    path: content/controller
    output: true
    name: NGINX Controller
    description: Documentation for NGINX Controller.
    parse_branch_index: false
    icon: notes
    preview:
      metadata:
        - text:
            - key: path
          icon: folder
    _editables: {}
    _inputs: {}
    _select_data: {}
    _structures: {}
    create:
      path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]'
      extra_data: {}
      _inputs: {}
      _select_data: {}
      _structures: {}
    disable_add: false
    disable_add_folder: true
    disable_file_actions: true
    schemas: 
     default:
        path: .cloudcannon/schemas/default.md
        reorder_inputs: true
        hide_extra_inputs: true
        remove_empty_inputs: false
        remove_extra_inputs: false
        name: Task (default)
        icon: task
        _editables: {}
        _inputs: {}
        _select_data: {}
        _structures: {}
  modsec_waf:
    path: content/modsec-waf
    output: true
    name: NGINX ModSec WAF
    description: Documentation for NGINX ModSec WAF.
    parse_branch_index: false
    icon: notes
    preview:
      metadata:
        - text:
            - key: path
          icon: folder
    _editables: {}
    _inputs: {}
    _select_data: {}
    _structures: {}
    disable_add: true
    disable_add_folder: true
    disable_file_actions: true
    schemas: 
      default:
        path: .cloudcannon/schemas/default.md
        reorder_inputs: true
        hide_extra_inputs: true
        remove_empty_inputs: false
        remove_extra_inputs: false
        name: Task (default)
        icon: task
        _editables: {}
        _inputs: {}
        _select_data: {}
        _structures: {}
  solution_bundles:
    path: content/solutions
    output: true
    name: NGINX Solution Bundles
    description: Instructions for deploying the multi-product solution bundles.
    parse_branch_index: false
    icon: notes
    preview:
      metadata:
        - text:
            - key: path
          icon: folder
    _editables: {}
    _inputs: {}
    _select_data: {}
    _structures: {}
    create:
      path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]'
      extra_data: {}
      _inputs: {}
      _select_data: {}
      _structures: {}
    disable_add: false
    disable_add_folder: false
    disable_file_actions: false
    schemas:
      default:
        path: .cloudcannon/schemas/default.md
        reorder_inputs: true
        hide_extra_inputs: true
        remove_empty_inputs: false
        remove_extra_inputs: false
        name: Task (default)
        icon: task
        _editables: {}
        _inputs: {}
        _select_data: {}
        _structures: {}
  includes:
    path: content/includes
    output: false
    name: Content Reuse
    description: A collection of files that can be reused in other documents across the website.
    filter:
      exclude:
        - index.md
    parse_branch_index: false
    icon: notes
    preview:
      metadata:
        - text:
            - key: path
          icon: folder
    _editables: {}
    _inputs: {}
    _select_data: {}
    _structures: {}
    create:
      path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]'
      extra_data: {}
      _inputs: {}
      _select_data: {}
      _structures: {}
    disable_add: false
    disable_add_folder: false
    disable_file_actions: false
    schemas:
      default:
        path: .cloudcannon/schemas/includes.md
        name: Includes template
      headless-collection:
        path: .cloudcannon/schemas/headless-collection.md
        name: Index.md template
  data:
    path: data
    output: false
    icon: dataset
    _editables: {}
    _enabled_editors: 
      - data
      - content
    _inputs: {}
    _select_data: {}
    _structures: {}
    create:
      path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]'
      extra_data: {}
      _inputs: {}
      _select_data: {}
      _structures: {}
    disable_add: false
    disable_add_folder: true
    disable_file_actions: true
    schemas: {}
collections_config_override: true
collection_groups:
  - heading: "Standalone Web Pages"
    collections: 
    - "standalone_pages"
  - heading: "Product Docs"
    collections:
    - "nginx_plus"
    - "nap_dos"
    - "nap_waf"
    - "nms"
    - "controller"
    - "modsec_waf"
  - heading: "Solutions"
    collections:
    - "solution_bundles"
  - heading: "Content Reuse"
    collections:
    - "includes"
_enabled_editors:
  - content
_inputs: {}
_select_data: {}
_structures: {}
_editables:
  text:
    bold: true
    copyformatting: true
    italic: true
    link: true
    redo: true
    removeformat: true
    strike: true
    subscript: true
    superscript: true
    underline: true
    undo: true
data_config: true
timezone: Etc/UTC
commit_templates:
  - template_string: '{commit_type}: {message|trim} {breaking_change|if=breaking_change_message}'
    _inputs:
      commit_type:
        type: select
        options:
          allow_empty: true
          values:
            - feature
            - fix
            - refactor
            - update
        cascade: true
      breaking_change_message:
        type: text
        cascade: true
    extra_data:
      breaking_change: |-

        ⚠️ {breaking_change_message}
_snippets_imports:
  hugo:
    exclude:
      - hugo_youtube
      - hugo_twitter
      - hugo_vimeo
      - hugo_instagram
_snippets:
  important:
    template: hugo_paired_shortcode_named_args
    inline: false
    preview:
      text: Important
      subtext:
        - key: content_markdown
        - Important note in a callout box.
      icon: priority_high
    definitions:
      shortcode_name: important
      content_key: content_markdown
      named_args: []
  note:
    template: hugo_paired_shortcode_named_args
    inline: false
    preview:
      text: Note
      subtext:
        - key: content_markdown
        - Note in callout box.
      icon: edit_note
    definitions:
      shortcode_name: note
      content_key: content_markdown
      named_args: []
  see-also:
    template: hugo_paired_shortcode_named_args
    inline: false
    preview:
      text: See also
      subtext:
        - key: content_markdown
        - See Also note in callout box.
      icon: visibility
    definitions:
      shortcode_name: see-also
      content_key: content_markdown
      named_args: []
  before-you-begin:
    template: hugo_paired_shortcode_named_args
    inline: false
    preview:
      text: Befor You Begin
      subtext:
        - key: content_markdown
        - Before You Begin note in callout box.
      icon: front_hand
    definitions:
      shortcode_name: before-you-begin
      content_key: content_markdown
      named_args: []
  deprecated:
    template: hugo_paired_shortcode_named_args
    inline: false
    preview:
      text: Deprecated
      subtext:
        - key: content_markdown
        - Deprecated callout in a box.
      icon: delete
    definitions:
      shortcode_name: deprecated
      content_key: content_markdown
      named_args: []
  caution:
    template: hugo_paired_shortcode_named_args
    inline: false
    preview:
      text: Caution
      subtext:
        - key: content_markdown
        - Caution callout in a box.
      icon: announcement
    definitions:
      shortcode_name: caution
      content_key: content_markdown
      named_args: []
  warning:
    template: hugo_paired_shortcode_named_args
    inline: false
    preview:
      text: Warning
      subtext:
        - key: content_markdown
        - Warning callout in a box.
      icon: warning
    definitions:
      shortcode_name: warning
      content_key: content_markdown
      named_args: []
  call-out:
    template: hugo_paired_shortcode_positional_args
    inline: false
    preview:
      text:
        - key: callout_title
        - Callout
      subtext:
        - key: content_markdown
        - Custome callout with title in a box.
      icon:
        - key: icon_param
        - document
    definitions:
      shortcode_name: call-out
      content_key: content_markdown
      positional_args:
        - editor_key: icon_param
          type: string
        - editor_key: callout_title
          type: string
  Internal comment:
    template: hugo_paired_shortcode_named_args
    inline: false
    preview:
      text: Comment (Internal only)
      subtext:
        - key: content_markdown
        - Internal comment that will not be rendered in the page.
      icon: tag
    definitions:
      shortcode_name: comment
      content_key: content_markdown
      named_args: []
  include:
    template: hugo_shortcode_positional_args
    inline: true
    preview:
      text: Include
      subtext:
        - key: url
        - Include snippet.
      icon: file_copy
    definitions:
      shortcode_name: include
      positional_args:
        - editor_key: url
          type: string
  bootstrap-table:
    template: hugo_paired_shortcode_positional_args
    inline: false
    preview:
      text: Bootstrap Table
      subtext:
        - key: content_markdown_table
        - type: code
        - Markdown table using Bootstrap.
      icon: table_chart
    definitions:
      shortcode_name: bootstrap-table
      content_key: content_markdown_table
      positional_args:
        - editor_key: table_style
    _inputs:
      content_markdown_table:
        type: code
        cascade: true
  raw-html:
    template: hugo_paired_shortcode_named_args
    inline: false
    preview:
      text: Raw HTML
      subtext:
        - key: content_code_block
        - Raw HTML Code.
      icon: html
    definitions:
      shortcode_name: raw-html
      content_key: content_code_block
      named_args: []
  img:
    template: hugo_shortcode_named_args
    inline: true
    preview:
      text:
        - key: src
        - Image
      subtext:
        - key: alt
        - Alternative text
      icon: image
    definitions:
      shortcode_name: img
      named_args:
        - editor_key: src
          type: string
        - editor_key: caption
          optional: true
          type: string
        - editor_key: alt
          optional: true
          type: string
        - editor_key: width
          optional: true
          type: string
        - editor_key: height
          optional: true
          type: string
  tab group:
    template: hugo_paired_shortcode_named_args
    inline: false
    preview:
      text:
        - key: name
        - Tab group section
      subtext:
        - key: content_code_block
        - Tabs content
      icon: tab
    definitions:
      shortcode_name: tabs
      content_key: content_code_block
      named_args:
        - editor_key: name
          type: string
  tab section:
    template: hugo_paired_markdown_shortcode_named_args
    inline: false
    preview:
      text:
        - key: name
        - Tab inside tabbed section
      subtext:
        - key: tab_content
        - Tab content
      icon: tab
    definitions:
      shortcode_name: tabs
      content_key: tab_content
      named_args:
        - editor_key: name
          type: string
  beta-badge:
    template: hugo_shortcode_positional_args
    inline: false
    preview:
      text: This topic documents an early access feature.
      subtext: >-
        These features are provided for you to try before they are generally
        available. You shouldn't use early access features for production
        purposes.
      icon: science
    definitions:
      shortcode_name: beta-badge
  relref:
    template: hugo_shortcode_positional_args
    inline: true
    preview:
      view: inline
      icon: link
      text:
        - key: url
        - Empty URL
    definitions:
      shortcode_name: relref
      positional_args:
        - editor_key: url
          type: string
  link:
    template: hugo_shortcode_positional_args
    inline: true
    preview:
      text:
        - key: text
        - Link to download a file
      icon: system_update_alt
    definitions:
      shortcode_name: link
      positional_args:
        - editor_key: url
          type: string
        - editor_key: text
  fontawesome-Icon:
    template: hugo_shortcode_positional_args
    inline: true
    preview:
      view: inline
      text: FA-icon
      icon:
        - key: icon_name
    definitions:
      shortcode_name: fa
      positional_args:
        - editor_key: icon_name
          type: string
        - editor_key: styles
          type: string
          optional: true
          remove_empty: true
  icon-resolved:
    template: hugo_markdown_shortcode_named_args
    inline: true
    preview:
      text: Resolved Bug Icon
      icon: bug_report
    definitions:
      shortcode_name: icon-resolved
      content_key: content_markdown
      named_args: []
  icon-bug:
    template: hugo_markdown_shortcode_named_args
    inline: true
    preview:
      text: Bug Icon
      icon: bug_report
    definitions:
      shortcode_name: icon-bug
      content_key: content_markdown
      named_args: []
  shortversions:
    template: hugo_shortcode_positional_args
    inline: false
    preview:
      text: Shortversions - This shortcode has been deprecated
      icon: format_list_numbered
    definitions:
      shortcode_name: shortversions
      positional_args:
        - editor_key: from
          type: string
        - editor_key: to
          type: string
        - editor_key: product
          type: string
  versions:
    template: hugo_shortcode_positional_args
    inline: false
    preview:
      text: Versions - This shortcode has been deprecated
      icon: format_list_numbered
    definitions:
      shortcode_name: versions
      positional_args:
        - editor_key: from
          type: string
        - editor_key: to
          type: string
        - editor_key: product
          type: string