sigs.k8s.io/kueue@v0.6.2/site/config.toml (about)

     1  baseURL = "/"
     2  title = "Kueue"
     3  
     4  enableRobotsTXT = true
     5  
     6  theme = "docsy"
     7  themesDir = "node_modules"
     8  
     9  ###############################################################################
    10  # Docsy
    11  ###############################################################################
    12  enableGitInfo = true
    13  
    14  # language settings
    15  contentDir = "content/en"
    16  defaultContentLanguage = "en"
    17  # tell Hugo not to include the /en/ element in the URL path for English docs
    18  defaultContentLanguageInSubdir = false
    19  # useful when translating
    20  enableMissingTranslationPlaceholders = true
    21  # disable taxonomies
    22  disableKinds = ["taxonomy", "taxonomyTerm"]
    23  # deprecated directories
    24  ignoreFiles = []
    25  ###############################################################################
    26  # Hugo - Top-level navigation (horizontal)
    27  ###############################################################################
    28  [menu]
    29  
    30    [[menu.main]]
    31      name = "GitHub"
    32      weight = 99
    33      pre = "<i class='fab fa-github pr-2'></i>"
    34      url = "https://github.com/kubernetes-sigs/kueue"
    35  
    36  ###############################################################################
    37  # Docsy - Goldmark markdown parser
    38  ###############################################################################
    39  [markup]
    40    [markup.goldmark]
    41      [markup.goldmark.renderer]
    42        unsafe = true
    43    [markup.highlight]
    44      # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
    45      style = "tango"
    46      guessSyntax = "true"
    47  
    48  ###############################################################################
    49  # Docsy - Image processing configuration
    50  ###############################################################################
    51  [imaging]
    52    resampleFilter = "CatmullRom"
    53    quality = 75
    54    anchor = "smart"
    55  
    56  ###############################################################################
    57  # Docsy - Services configuration
    58  ###############################################################################
    59  [services]
    60    [services.googleAnalytics]
    61    id = "UA-135379910-1"
    62  
    63  ###############################################################################
    64  # Docsy - Language configuration
    65  ###############################################################################
    66  [languages]
    67    [languages.en]
    68      languageName ="English"
    69      # weight used for sorting in the language menu
    70      weight = 1
    71  
    72  ###############################################################################
    73  # Docsy - Site Parameters
    74  ###############################################################################
    75  [params]
    76    github_repo = "https://github.com/kubernetes-sigs/kueue"
    77    github_project_repo = "https://github.com/kubernetes-sigs/kueue"
    78    github_subdir = "site"
    79    RSSLink = "/index.xml"
    80    author = "kubernetes" # add your company name
    81    github = "kubernetes" # add your github profile name
    82    twitter = "kubernetesio" # add your twitter profile
    83  
    84    copyright = "The Kubernetes Authors"
    85  
    86    # Google Custom Search Engine ID.
    87    # gcs_engine_id = "007239566369470735695:624rglujm-w"
    88    prism_syntax_highlighting = true
    89    # Text label for the version menu in the top bar of the website.
    90    version_menu = "Version"
    91  
    92    # The major.minor version tag for the version of the docs represented in this
    93    # branch of the repository. Used in the "version-banner" partial to display a
    94    # version number for this doc set.
    95    version = "v0.6.2"
    96  
    97    # Flag used in the "version-banner" partial to decide whether to display a
    98    # banner on every page indicating that this is an archived version of the docs.
    99    archived_version = false
   100  
   101    # A link to latest version of the docs. Used in the "version-banner" partial to
   102    # point people to the main doc site.
   103    url_latest_version = "https://sigs.k8s.io/kueue/docs"
   104  
   105    # A variable used in various docs to determine URLs for config files etc.
   106    # To find occurrences, search the repo for 'params "githubbranch"'.
   107    githubbranch = "main"
   108  
   109    # These entries appear in the drop-down menu at the top of the website.
   110    # [[params.versions]]
   111    #   version = "main"
   112    #   githubbranch = "main"
   113    #   url = "https://kueue.sigs.k8s.io"
   114  
   115    # User interface configuration
   116    [params.ui]
   117      # Enable the logo
   118      navbar_logo = true
   119      # Enable to show the side bar menu in its compact state.
   120      sidebar_menu_compact = true
   121      # Enable the search box in the side bar.
   122      sidebar_search_disable = false
   123      # Set to true to disable breadcrumb navigation.
   124      breadcrumb_disable = false
   125      # Show expand/collapse icon for sidebar sections
   126      sidebar_menu_foldable = true
   127      # Disable about button in footer
   128      footer_about_disable = true
   129  
   130        # Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
   131        # This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
   132        # If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
   133        # add "hide_feedback: true" to the page's front matter.
   134        [params.ui.feedback]
   135          enable = true
   136          # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
   137          yes = 'Glad to hear it! Please <a href="https://github.com/kubernetes-sigs/kueue/issues/new">tell us how we can improve</a>.'
   138          no = 'Sorry to hear that. Please <a href="https://github.com/kubernetes-sigs/kueue/issues/new">tell us how we can improve</a>.'
   139  
   140  [params.links]
   141  # End user relevant links. These will show up on left side of footer and in the community page if you have one.
   142    [[params.links.user]]
   143      name = "User mailing list"
   144      url = "https://groups.google.com/a/kubernetes.io/g/wg-batch"
   145      icon = "fa fa-envelope"
   146      desc = "Discussion and help from your fellow users"
   147    [[params.links.user]]
   148      name ="Twitter"
   149      url = "https://twitter.com/kubernetesio"
   150      icon = "fab fa-twitter"
   151      desc = "Follow us on Twitter to get the latest news!"
   152    [[params.links.user]]
   153      name = "Stack Overflow"
   154      url = "https://stackoverflow.com/questions/tagged/kubernetes"
   155      icon = "fab fa-stack-overflow"
   156      desc = "Practical questions and curated answers"
   157    [[params.links.user]]
   158      name = "Slack"
   159      url = "https://kubernetes.slack.com/"
   160      icon = "fab fa-slack"
   161      desc = "Chat with other project developers"