From: Filipe Brandenburger Date: Wed, 2 Jan 2019 22:16:34 +0000 (-0800) Subject: docs: add a "front matter" snippet to our markdown pages X-Git-Tag: v241-rc1~121^2~1 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=c3e270f4eeda70396b5af8dc01ac2a7234f098b9;p=thirdparty%2Fsystemd.git 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 83acdab4465..6f7182a4b3f 100644 --- 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 ceb060c0c9d..58178ad2f70 100644 --- 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 a0c7f399707..50488ee97a2 100644 --- 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 3724f78a800..3612ff1d331 100644 --- 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 ed23a0a142d..7cd27a44b27 100644 --- 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 b3b46cd6d84..da290ecda32 100644 --- 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 be0e13f6535..18363f0f1bb 100644 --- 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 a91e119c4a9..4a1cc59ce61 100644 --- 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 6cfdd6f1799..f40d9a010a6 100644 --- 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 bcb093fbdca..f8b98bcbae2 100644 --- 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 619a57eb3f3..99b5b03b687 100644 --- 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 17136060ce5..b14be721285 100644 --- 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 4b37a19455b..2dbeeee760b 100644 --- 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 73d60477cdd..b29016f93db 100644 --- 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 11794aae639..4bf5ab8dc17 100644 --- 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 89a185b5271..0ac77f04976 100644 --- 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 9c454530834..d155c1c8750 100644 --- 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 c59fefc5cd6..25345a918f6 100644 --- 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 2140253674e..890c4f8e767 100644 --- 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)