docs: add a "front matter" snippet to our markdown pages

It turns out Jekyll (the engine behind GitHub Pages) requires that pages
include a "Front Matter" snippet of YAML at the top for proper rendering.

Omitting it will still render the pages, but including it opens up new
possibilities, such as using a {% for %} loop to generate index.md instead of
requiring a separate script.

I'm hoping this will also fix the issue with some of the pages (notably
CODE_OF_CONDUCT.html) not being available under systemd.io

Tested locally by rendering the website with Jekyll. Before this change, the
*.md files were kept unchanged (so not sure how that even works?!), after this
commit, proper *.html files were generated from it.

diff --git a/docs/AUTOMATIC_BOOT_ASSESSMENT.md b/docs/AUTOMATIC_BOOT_ASSESSMENT.md
index 83acdab446531d434eb4ffd68ac9798ccea44856..6f7182a4b3f83ec87ae5d06e8208f55e28573f3f 100644 (file)
--- a/docs/AUTOMATIC_BOOT_ASSESSMENT.md
+++ b/docs/AUTOMATIC_BOOT_ASSESSMENT.md
@@ -1,3 +1,7 @@
+---
+title: Automatic Boot Assessment
+---
+
 # Automatic Boot Assessment
 
 systemd provides support for automatically reverting back to the previous

diff --git a/docs/BLOCK_DEVICE_LOCKING.md b/docs/BLOCK_DEVICE_LOCKING.md
index ceb060c0c9dbca992a84888d9672fba9852446bc..58178ad2f70b07775bd761fe84f2929855189fb4 100644 (file)
--- a/docs/BLOCK_DEVICE_LOCKING.md
+++ b/docs/BLOCK_DEVICE_LOCKING.md
@@ -1,3 +1,7 @@
+---
+title: Locking Block Device Access
+---
+
 # Locking Block Device Access
 
 *TL;DR: Use BSD file locks

diff --git a/docs/BOOT_LOADER_INTERFACE.md b/docs/BOOT_LOADER_INTERFACE.md
index a0c7f3997072f841fc9db57f9dd77ed02d77406f..50488ee97a2f59a0e4eac0cf44f482a2d6a2eab6 100644 (file)
--- a/docs/BOOT_LOADER_INTERFACE.md
+++ b/docs/BOOT_LOADER_INTERFACE.md
@@ -1,3 +1,7 @@
+---
+title: The Boot Loader Interface
+---
+
 # The Boot Loader Interface
 
 systemd can interface with the boot loader to receive performance data and

diff --git a/docs/BOOT_LOADER_SPECIFICATION.md b/docs/BOOT_LOADER_SPECIFICATION.md
index 3724f78a800bf81710d8b77b6d242020cb8ee94a..3612ff1d331519906a7f9d88cfd6697966d96a78 100644 (file)
--- a/docs/BOOT_LOADER_SPECIFICATION.md
+++ b/docs/BOOT_LOADER_SPECIFICATION.md
@@ -1,3 +1,7 @@
+---
+title: The Boot Loader Specification
+---
+
 # The Boot Loader Specification
 
 _TL;DR: Currently there's little cooperation between multiple distributions in dual-boot (or triple, ... multi-boot) setups, and we'd like to improve this situation by getting everybody to commit to a single boot configuration format that is based on drop-in files, and thus is robust, simple, works without rewriting configuration files and is free of namespace clashes._

diff --git a/docs/CGROUP_DELEGATION.md b/docs/CGROUP_DELEGATION.md
index ed23a0a142de516a5cf26da9fc53beb32ca713a4..7cd27a44b27f90031c1892d3ac2143c8daa815a6 100644 (file)
--- a/docs/CGROUP_DELEGATION.md
+++ b/docs/CGROUP_DELEGATION.md
@@ -1,3 +1,7 @@
+---
+title: Control Group APIs and Delegation
+---
+
 # Control Group APIs and Delegation
 
 *Intended audience: hackers working on userspace subsystems that require direct

diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
index b3b46cd6d84f190dd80f801218b1185441a7fc6d..da290ecda32faadb26e0054bb9e27ea3c3c0da5b 100644 (file)
--- a/docs/CODE_OF_CONDUCT.md
+++ b/docs/CODE_OF_CONDUCT.md
@@ -1,3 +1,7 @@
+---
+title: The systemd Community Conduct Guidelines
+---
+
 # The systemd Community Conduct Guidelines
 
 This document provides community guidelines for a safe, respectful, productive, and collaborative place for any person who is willing to contribute to systemd. It applies to all “collaborative spaces”, which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.).

diff --git a/docs/CODE_QUALITY.md b/docs/CODE_QUALITY.md
index be0e13f6535ec1ba01d4974422b3f4ac5798fb38..18363f0f1bba1bac8b9d3d3bef84ba287337b9bd 100644 (file)
--- a/docs/CODE_QUALITY.md
+++ b/docs/CODE_QUALITY.md
@@ -1,3 +1,7 @@
+---
+title: Code Quality Tools
+---
+
 # Code Quality Tools
 
 The systemd project has a number of code quality tools set up in the source

diff --git a/docs/CODING_STYLE.md b/docs/CODING_STYLE.md
index a91e119c4a9a5e8e2c149ea3275440c8a812f5f1..4a1cc59ce61a54fb3c915639a9df32eb69147f3a 100644 (file)
--- a/docs/CODING_STYLE.md
+++ b/docs/CODING_STYLE.md
@@ -1,3 +1,7 @@
+---
+title: Coding Style
+---
+
 # Coding Style
 
 - 8ch indent, no tabs, except for files in `man/` which are 2ch indent,

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
index 6cfdd6f179981558747ddc8604c6a6e16c8cfcf0..f40d9a010a6412dda4f5e68ef2e5696f8c6c7162 100644 (file)
--- a/docs/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -1,3 +1,7 @@
+---
+title: Contributing
+---
+
 # Contributing
 
 We welcome contributions from everyone. However, please follow the following guidelines when posting a GitHub Pull Request or filing a GitHub Issue on the systemd project:

diff --git a/docs/DISTRO_PORTING.md b/docs/DISTRO_PORTING.md
index bcb093fbdca75e67249ce98ea7f0aceb10f6a695..f8b98bcbae247a844deb8fe804f56d08f84a5c26 100644 (file)
--- a/docs/DISTRO_PORTING.md
+++ b/docs/DISTRO_PORTING.md
@@ -1,3 +1,7 @@
+---
+title: Porting systemd To New Distributions
+---
+
 # Porting systemd To New Distributions
 
 ## HOWTO

diff --git a/docs/ENVIRONMENT.md b/docs/ENVIRONMENT.md
index 619a57eb3f30f3564d2d53166841418f5aeb797d..99b5b03b68755ce632c017e9259d1e22789d16d3 100644 (file)
--- a/docs/ENVIRONMENT.md
+++ b/docs/ENVIRONMENT.md
@@ -1,3 +1,7 @@
+---
+title: Known Environment Variables
+---
+
 # Known Environment Variables
 
 A number of systemd components take additional runtime parameters via

diff --git a/docs/HACKING.md b/docs/HACKING.md
index 17136060ce59faf5a272796ff053a8b42387713e..b14be72128538a68f137c3a6bb61a4ae01a0f515 100644 (file)
--- a/docs/HACKING.md
+++ b/docs/HACKING.md
@@ -1,3 +1,7 @@
+---
+title: Hacking on systemd
+---
+
 # Hacking on systemd
 
 We welcome all contributions to systemd. If you notice a bug or a missing

diff --git a/docs/PORTABLE_SERVICES.md b/docs/PORTABLE_SERVICES.md
index 4b37a19455bf9d54182608cb9eca9ddc8799e6f8..2dbeeee760b1a6c6f374c8674cbd3655f03a978f 100644 (file)
--- a/docs/PORTABLE_SERVICES.md
+++ b/docs/PORTABLE_SERVICES.md
@@ -1,3 +1,7 @@
+---
+title: Portable Services Introduction
+---
+
 # Portable Services Introduction
 
 This systemd version includes a preview of the "portable service"

diff --git a/docs/PREDICTABLE_INTERFACE_NAMES.md b/docs/PREDICTABLE_INTERFACE_NAMES.md
index 73d60477cdd81ac5847700f82a22aa62ce1c6bef..b29016f93dbb5671dc4e48db10bb0d0e02199de0 100644 (file)
--- a/docs/PREDICTABLE_INTERFACE_NAMES.md
+++ b/docs/PREDICTABLE_INTERFACE_NAMES.md
@@ -1,3 +1,7 @@
+---
+title: Predictable Network Interface Names
+---
+
 # Predictable Network Interface Names
 
 Starting with v197 systemd/udev will automatically assign predictable, stable network interface names for all local Ethernet, WLAN and WWAN interfaces. This is a departure from the traditional interface naming scheme ("eth0", "eth1", "wlan0", ...), but should fix real problems.

diff --git a/docs/RELEASE.md b/docs/RELEASE.md
index 11794aae63974bdbad45edc26e7c93a535f216f5..4bf5ab8dc174e08f833c680960812bffceb81ff7 100644 (file)
--- a/docs/RELEASE.md
+++ b/docs/RELEASE.md
@@ -1,3 +1,7 @@
+---
+title: Steps to a Successful Release
+---
+
 # Steps to a Successful Release
 
 1. Add all items to NEWS

diff --git a/docs/TRANSIENT-SETTINGS.md b/docs/TRANSIENT-SETTINGS.md
index 89a185b5271ae4a8487658e38e1d48614a47a324..0ac77f04976a849c4812e00798cf48f71790fc6a 100644 (file)
--- a/docs/TRANSIENT-SETTINGS.md
+++ b/docs/TRANSIENT-SETTINGS.md
@@ -1,3 +1,7 @@
+---
+title: What settings are currently available for transient units?
+---
+
 # What settings are currently available for transient units?
 
 Our intention is to make all settings that are available as unit file settings

diff --git a/docs/TRANSLATORS.md b/docs/TRANSLATORS.md
index 9c4545308345fe2c40cd3d534eb13cda5a8db8ef..d155c1c87500b9eae741628829c44205f3e2d3a1 100644 (file)
--- a/docs/TRANSLATORS.md
+++ b/docs/TRANSLATORS.md
@@ -1,3 +1,7 @@
+---
+title: Notes for Translators
+---
+
 # Notes for Translators
 
 systemd depends on the `gettext` package for multilingual support.

diff --git a/docs/UIDS-GIDS.md b/docs/UIDS-GIDS.md
index c59fefc5cd62960d6026b7d5c3631b5df118d7e6..25345a918f65a733a3e6750889e3810b8e022eda 100644 (file)
--- a/docs/UIDS-GIDS.md
+++ b/docs/UIDS-GIDS.md
@@ -1,3 +1,7 @@
+---
+title: Users, Groups, UIDs and GIDs on `systemd` Systems
+---
+
 # Users, Groups, UIDs and GIDs on `systemd` Systems
 
 Here's a summary of the requirements `systemd` (and Linux) make on UID/GID

diff --git a/docs/index.md b/docs/index.md
index 2140253674ea97285201c34ae198ada6aaab5d4b..890c4f8e767ba5c0df6cb4fbd9608f0f6e324914 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,3 +1,7 @@
+---
+title: systemd Documentation
+---
+
 # systemd Documentation
 
 * [Automatic Boot Assessment](https://systemd.io/AUTOMATIC_BOOT_ASSESSMENT)