site/config.toml

baseURL = "/"
title = "Kueue"

enableRobotsTXT = true

theme = "docsy"
themesDir = "node_modules"

###############################################################################
# Docsy
###############################################################################
enableGitInfo = true

# language settings
contentDir = "content/en"
defaultContentLanguage = "en"
# tell Hugo not to include the /en/ element in the URL path for English docs
defaultContentLanguageInSubdir = false
# useful when translating
enableMissingTranslationPlaceholders = true
# disable taxonomies
disableKinds = ["taxonomy", "taxonomyTerm"]
# deprecated directories
ignoreFiles = []
###############################################################################
# Hugo - Top-level navigation (horizontal)
###############################################################################
[menu]

  [[menu.main]]
    name = "GitHub"
    weight = 99
    pre = "<i class='fab fa-github pr-2'></i>"
    url = "https://github.com/kubernetes-sigs/kueue"

###############################################################################
# Docsy - Goldmark markdown parser
###############################################################################
[markup]
  [markup.goldmark]
    [markup.goldmark.renderer]
      unsafe = true
  [markup.highlight]
    # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
    style = "tango"
    guessSyntax = "true"

###############################################################################
# Docsy - Image processing configuration
###############################################################################
[imaging]
  resampleFilter = "CatmullRom"
  quality = 75
  anchor = "smart"

###############################################################################
# Docsy - Services configuration
###############################################################################
[services]
  [services.googleAnalytics]
  id = "UA-135379910-1"

###############################################################################
# Docsy - Language configuration
###############################################################################
[languages]
  [languages.en]
    languageName ="English"
    # weight used for sorting in the language menu
    weight = 1

###############################################################################
# Docsy - Site Parameters
###############################################################################
[params]
  github_repo = "https://github.com/kubernetes-sigs/kueue"
  github_project_repo = "https://github.com/kubernetes-sigs/kueue"
  github_subdir = "site"
  RSSLink = "/index.xml"
  author = "kubernetes" # add your company name
  github = "kubernetes" # add your github profile name
  twitter = "kubernetesio" # add your twitter profile

  copyright = "The Kubernetes Authors"

  # Google Custom Search Engine ID.
  # gcs_engine_id = "007239566369470735695:624rglujm-w"
  prism_syntax_highlighting = true
  # Text label for the version menu in the top bar of the website.
  version_menu = "Version"

  # The major.minor version tag for the version of the docs represented in this
  # branch of the repository. Used in the "version-banner" partial to display a
  # version number for this doc set.
  version = "main"

  # Flag used in the "version-banner" partial to decide whether to display a
  # banner on every page indicating that this is an archived version of the docs.
  archived_version = false

  # A link to latest version of the docs. Used in the "version-banner" partial to
  # point people to the main doc site.
  url_latest_version = "https://sigs.k8s.io/kueue/docs"

  # A variable used in various docs to determine URLs for config files etc.
  # To find occurrences, search the repo for 'params "githubbranch"'.
  githubbranch = "main"

  # These entries appear in the drop-down menu at the top of the website.
  # [[params.versions]]
  #   version = "main"
  #   githubbranch = "main"
  #   url = "https://kueue.sigs.k8s.io"

  # User interface configuration
  [params.ui]
    # Enable the logo
    navbar_logo = true
    # Enable to show the side bar menu in its compact state.
    sidebar_menu_compact = true
    # Enable the search box in the side bar.
    sidebar_search_disable = false
    # Set to true to disable breadcrumb navigation.
    breadcrumb_disable = false
    # Show expand/collapse icon for sidebar sections
    sidebar_menu_foldable = true
    # Disable about button in footer
    footer_about_disable = true

      # Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
      # This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
      # If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
      # add "hide_feedback: true" to the page's front matter.
      [params.ui.feedback]
        enable = true
        # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
        yes = 'Glad to hear it! Please <a href="https://github.com/kubernetes-sigs/kueue/issues/new">tell us how we can improve</a>.'
        no = 'Sorry to hear that. Please <a href="https://github.com/kubernetes-sigs/kueue/issues/new">tell us how we can improve</a>.'

[params.links]
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
  [[params.links.user]]
    name = "User mailing list"
    url = "https://groups.google.com/a/kubernetes.io/g/wg-batch"
    icon = "fa fa-envelope"
    desc = "Discussion and help from your fellow users"
  [[params.links.user]]
    name ="Twitter"
    url = "https://twitter.com/kubernetesio"
    icon = "fab fa-twitter"
    desc = "Follow us on Twitter to get the latest news!"
  [[params.links.user]]
    name = "Stack Overflow"
    url = "https://stackoverflow.com/questions/tagged/kubernetes"
    icon = "fab fa-stack-overflow"
    desc = "Practical questions and curated answers"
  [[params.links.user]]
    name = "Slack"
    url = "https://kubernetes.slack.com/"
    icon = "fab fa-slack"
    desc = "Chat with other project developers"