site/hugo.yaml

#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
#

baseURL: 'https://polaris.apache.org/'
languageCode: 'en-us'
title: 'Apache Polaris'
sectionPagesMenu: 'main'
enableRobotsTXT: true

permalinks:
  blog: "/:section/:year/:month/:day/:slug/"

params:
  author.name: 'Apache Polaris contributors'

  github_repo: https://github.com/apache/polaris
  github_project_repo: https://github.com/apache/polaris
  github_branch: main
  github_subdir: site
  privacy_policy: https://privacy.apache.org/policies/privacy-policy-public.html

  # Offline search from Docsy theme, uses "Lunr", see https://www.docsy.dev/docs/adding-content/search/#local-search-with-lunr
  # The file layouts/partials/head.html has been adopted to embed the JS
  offlineSearch: true

  links:
    # End user relevant links. These will show up on left side of footer and in the community page if you have one.
    user:
      - name: Slack
        url: https://apache-polaris.slack.com/
        icon: fa-regular fa-comment-dots
        desc: Chat with other project developers
      - name: Community Meetings
        url: /community/meetings/
        icon: fa-brands fa-square-youtube
        desc: Upcoming, live and recorded Community Meetings
    developer:
      - name: Dev mailing list
        url: https://lists.apache.org/list.html?dev@polaris.apache.org
        icon: fa fa-envelope
        desc: Discussion and help from your fellow users
      - name: GitHub
        url: https://github.com/apache/polaris
        icon: fab fa-github
        desc: Development takes place here!

  # Not using Docsy's mechanism to show a "Releases" menu, because we want to differentiate between "active" and
  # "EOL" releases and only show the "active" ones in the top navbar - and have the `Releases` menu not appear
  # at the very right in the navbar.
  active_releases:
    # Mention all active releases here, in semver descending order
    - "1.0.0"
    - "0.9.0"

  ui:
    ul_show: 1
    sidebar_menu_compact: true
    sidebar_menu_foldable: true
    sidebar_cache_limit: 1000
    # Dark doesn't look great for example with the `redoc` shortcode :(
    #showLightDarkModeMenu: true
    sidebar_search_disable: true

  plantuml:
    # Disabled for now, loads external JS, see ASF data policy
    # https://privacy.apache.org/policies/website-policy.html
    enable: false
  markmap:
    # Disabled for now, loads external JS, see ASF data policy
    # https://privacy.apache.org/policies/website-policy.html
    enable: false

imaging:
  resampleFilter: "CatmullRom"
  quality: 75
  anchor: "smart"

menu:
  main:
    - name: GitHub
      url: https://github.com/apache/polaris

    - name: "Documentation"
      identifier: "releases"
      weight: 100
      params:
        orderby: weight.desc
    - name: "All Releases"
      identifier: "all-releases-page"
      url: "/releases/"
      parent: "releases"
    - name: "0.9.0"
      url: "/in-dev/0.9.0/"
      parent: "releases"
    - name: "In Development"
      url: "/in-dev/unreleased/"
      parent: "releases"

    - name: "Downloads"
      identifier: "downloads"
      url: "/downloads"
      weight: 200

    - name: "Community"
      identifier: "community"
      weight: 300
    - name: "Community Page"
      parent: "community"
      url: "/community/"
      weight: 10
    - name: "Meetings"
      parent: "community"
      url: "/community/meetings"
      weight: 20
    - name: "Proposals & Roadmap"
      parent: "community"
      url: "/community/proposals"
      weight: 30
    - name: "Code Of Conduct"
      parent: "community"
      url: "/community/code-of-conduct"
      weight: 40
    - name: "Chat Bylaws"
      parent: "community"
      url: "/community/chat-bylaws"
      weight: 50
    - name: "Contributing Guidelines"
      parent: "community"
      url: "/community/contributing-guidelines"
      weight: 60

    - name: "ASF"
      pre: "<i class='fa-solid fa-feather'></i>"
      identifier: "asf"
      weight: 900
      params:
        rel: "external"
        external: true
    - name: "Foundation"
      parent: "asf"
      url: "https://www.apache.org/"
      weight: 41
      params:
        rel: "external"
        external: true
    - name: "License"
      parent: "asf"
      url: "https://www.apache.org/licenses/"
      weight: 42
      params:
        rel: "external"
        external: true
    - name: "Events"
      parent: "asf"
      url: "https://www.apache.org/events/current-event.html"
      weight: 43
      params:
        rel: "external"
        external: true
    - name: "Privacy"
      parent: "asf"
      url: "https://privacy.apache.org/policies/privacy-policy-public.html"
      weight: 44
      params:
        rel: "external"
        external: true
    - name: "Security"
      parent: "asf"
      url: "https://github.com/apache/polaris/blob/main/SECURITY.md"
      weight: 45
      params:
        rel: "external"
        external: true
    - name: "Sponsorship"
      parent: "asf"
      url: "https://www.apache.org/foundation/sponsorship.html"
      weight: 46
      params:
        rel: "external"
        external: true
    - name: "Thanks"
      parent: "asf"
      url: "https://www.apache.org/foundation/thanks.html"
      weight: 47
      params:
        rel: "external"
        external: true

module:
  hugoVersion:
    extended: true
    # The Hugo versions (as of 2024/09/04):
    #   in latest Ubuntu 24.04: 0.123.7
    #   in brew: 0.134.0
    min: 0.123.7
  imports:
    - path: github.com/google/docsy
      # Pin to this release, newer releases _might_ break the customized layouts
      version: v0.10.0

outputs:
  section:
    - HTML
    - RSS
    # Print support disabled until the `releases` layout supports it
    #- print

markup:
  highlight:
    anchorLineNos: false
    codeFences: true
    guessSyntax: false
    hl_Lines: ""
    hl_inline: false
    lineAnchors: ''
    lineNoStart: 1
    lineNos: false
    lineNumbersInTable: true
    noClasses: true
    noHl: false
    style: 'monokai'
    tabWidth: 4
  goldmark:
    renderer:
      unsafe: true

security:
  exec:
    # Add `asciidoctor` as an allowed executable
    allow: [ '^(dart-)?sass(-embedded)?$', '^go$', '^npx$', '^postcss$', '^asciidoctor$' ]

privacy:
  googleAnalytics:
    disable: true
  instagram:
    simple: true
  twitter:
    enableDNT: false
    simple: true
  vimeo:
    enableDNT: true
    simple: true
  youtube:
    privacyEnhanced: true