1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-14 11:57:51 +00:00
node-feature-discovery/docs/_config.yml
Markus Lehtonen b2bc18f5a5 docs: use jekyll-rtd-theme from a ruby gem
The upstream repo (and the release downloads)
github.com/rundocs/jekyll-rtd-theme has been deleted. This broke our
docs generation as the remote theme configuration depended on
downloading the release artefact.

This patch changes the docs building to use a Ruby gem instead of the
remote theme setting. To complicate matters, the gem has an seemingly
incorrect (too strict) version dependency. To mitigate this, we now
install bundler-override plugin to ignore this particular dependency.

The netlify conf is a hack, but I wasn't able to figure out a way how to
install the bundler-override plugin without doing all ruby
initialization in the build command.
2024-08-08 23:33:37 +03:00

61 lines
2.1 KiB
YAML

# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
title: Node Feature Discovery
description: >- # this means to ignore newlines until "baseurl:"
Documentation of Node Feature Discovery - a Kubernetes add-on for discovering
and advertising hardware features and system configuration in the cluster.
url: "https://kubernetes-sigs.github.com" # the base hostname & protocol for your site, e.g. http://example.com
repository: kubernetes-sigs/node-feature-discovery
# Build settings
markdown: kramdown
kramdown:
toc_levels: 1..3
theme: jekyll-rtd-theme
# Exclude from processing.
# The following items will not be processed, by default. Create a custom list
# to override the default setting.
# exclude:
# - Gemfile
# - Gemfile.lock
# - node_modules
# - vendor/bundle/
# - vendor/cache/
# - vendor/gems/
# - vendor/ruby/
# Document versioning
version: master
display_version_list: true
# Customize page width (make it wider) for large screens
scss: |
@media(min-width: 1280px){
.content-wrap{
max-width: 1200px
}
}
# Release is the full released version number. Used to make external links to
# point to the correct blobs in the Github repo. This is also the version shown
# in the sidebar (top left corner of the page)
release: master
# Container image which to point to in the documentation
container_image: gcr.io/k8s-staging-nfd/node-feature-discovery:master