mirrors/node-feature-discovery
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-14 11:57:51 +00:00
Code Activity
node-feature-discovery/docs/_config.yml

54 lines
2 KiB
YAML
Raw Normal View History

docs: initial site setup Bootstrap a new Jekyll site with stub content for testing gh-pages integration. Use jekyll-rdt-theme from https://github.com/rundocs/jekyll-rtd-theme
2020-09-07 13:27:54 +00:00
# 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
docs: update jekyll-rdt-theme to v2.0.10 Update jekyll-rdt-theme to the latest released version. Also sync site customization (docs/_includes) with that.
2021-10-11 07:34:58 +00:00
remote_theme: rundocs/jekyll-rtd-theme@v2.0.10
docs: initial site setup Bootstrap a new Jekyll site with stub content for testing gh-pages integration. Use jekyll-rdt-theme from https://github.com/rundocs/jekyll-rtd-theme
2020-09-07 13:27:54 +00:00
# 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/
docs: add support for versioned documentation Customize the Jekyll theme to add a simple list of versions.
2020-10-06 07:22:08 +00:00
docs: make the list of available versions dynamic Make the list of available versions dynamic. The items displayed is now generated with javascript. The parent directory of the site is supposed to contain versions.js providing getVersionListItems() that returns the available versions. The update-gh-pages.sh script is modified to update/create versions.js on every invocation. It simply lists all directories in the root directory and adds them to the version list.
2020-10-21 08:42:39 +00:00
# Document versioning
docs: add support for versioned documentation Customize the Jekyll theme to add a simple list of versions.
2020-10-06 07:22:08 +00:00
version: master
docs: make the list of available versions dynamic Make the list of available versions dynamic. The items displayed is now generated with javascript. The parent directory of the site is supposed to contain versions.js providing getVersionListItems() that returns the available versions. The update-gh-pages.sh script is modified to update/create versions.js on every invocation. It simply lists all directories in the root directory and adds them to the version list.
2020-10-21 08:42:39 +00:00
display_version_list: true
docs: show full version number in sidebar Change the sidebar customization so that the full version (e.g. v0.8.2) is displayed, instead of the truncated "releae branch version" (e.g. v0.8) in the top left corner of the page. The items in the version menu are unchanged and will still show the shorter form.
2021-05-19 07:37:12 +00:00
# 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)
docs: support versioned links to gihub blobs Make the links point to the blob from the release corresponding the documentation.
2020-10-08 17:15:26 +00:00
release: master
docs: specify container image in config
2020-11-20 14:48:57 +00:00
# Container image which to point to in the documentation
container_image: gcr.io/k8s-staging-nfd/node-feature-discovery:master
Copy permalink