Merge pull request #11317 from filbranden/docs1

Improvements to systemd.io generation

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

docs/BLOCK_DEVICE_LOCKING.md

@@ -1,3 +1,7 @@
+---
+title: Locking Block Device Access
+---
+
 # Locking Block Device Access
 
 *TL;DR: Use BSD file locks

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

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._

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

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.).

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

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,

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:

docs/DISTRO_PORTING.md

@@ -1,3 +1,7 @@
+---
+title: Porting systemd To New Distributions
+---
+
 # Porting systemd To New Distributions
 
 ## HOWTO

docs/ENVIRONMENT.md

@@ -1,3 +1,7 @@
+---
+title: Known Environment Variables
+---
+
 # Known Environment Variables
 
 A number of systemd components take additional runtime parameters via

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

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"

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.

docs/RELEASE.md

@@ -1,3 +1,7 @@
+---
+title: Steps to a Successful Release
+---
+
 # Steps to a Successful Release
 
 1. Add all items to NEWS

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

docs/TRANSLATORS.md

@@ -1,3 +1,7 @@
+---
+title: Notes for Translators
+---
+
 # Notes for Translators
 
 systemd depends on the `gettext` package for multilingual support.

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

docs/index.md

@@ -1,20 +1,11 @@
+---
+title: systemd Documentation
+---
+
 # systemd Documentation
 
-* [Automatic Boot Assessment](https://systemd.io/AUTOMATIC_BOOT_ASSESSMENT)
-* [Locking Block Device Access](https://systemd.io/BLOCK_DEVICE_LOCKING)
-* [The Boot Loader Interface](https://systemd.io/BOOT_LOADER_INTERFACE)
-* [The Boot Loader Specification](https://systemd.io/BOOT_LOADER_SPECIFICATION)
-* [Control Group APIs and Delegation](https://systemd.io/CGROUP_DELEGATION)
-* [The systemd Community Conduct Guidelines](https://github.com/systemd/systemd/blob/master/docs/CODE_OF_CONDUCT.md)
-* [Code Quality Tools](https://systemd.io/CODE_QUALITY)
-* [Coding Style](https://systemd.io/CODING_STYLE)
-* [Contributing](https://github.com/systemd/systemd/blob/master/docs/CONTRIBUTING.md)
-* [Porting systemd To New Distributions](https://systemd.io/DISTRO_PORTING)
-* [Predictable Network Interface Names](https://systemd.io/PREDICTABLE_INTERFACE_NAMES)
-* [Known Environment Variables](https://systemd.io/ENVIRONMENT)
-* [Hacking on systemd](https://systemd.io/HACKING)
-* [Portable Services Introduction](https://systemd.io/PORTABLE_SERVICES)
-* [Steps to a Successful Release](https://systemd.io/RELEASE)
-* [What settings are currently available for transient units?](https://systemd.io/TRANSIENT-SETTINGS)
-* [Notes for Translators](https://systemd.io/TRANSLATORS)
-* [Users, Groups, UIDs and GIDs on `systemd` Systems](https://systemd.io/UIDS-GIDS)
+{% for p in site.pages %}
+  {% if p.url != page.url and p.title %}
+* [{{ p.title }}]({{ p.url | relative_url }})
+  {% endif %}
+{% endfor %}

meson.build

@@ -3058,10 +3058,6 @@ run_target(
         depends : [man, libsystemd, libudev],
         command : [meson_check_api_docs_sh, libsystemd.full_path(), libudev.full_path()])
 
-run_target(
-        'make-index-md',
-        command : ['sh', '@0@/tools/make-index-md.sh'.format(meson.source_root()), meson.source_root()])
-
 ############################################################
 
 status = [

tools/make-index-md.sh

@@ -1,32 +0,0 @@
-#!/bin/sh
-
-set -eu
-
-cd "$@"/docs/
-(
-        echo -e "# systemd Documentation\n"
-
-        for f in *.md ; do
-                if [ "x$f" != "xindex.md" ] ; then
-                        t=`grep "^# " "$f" | head -n 1 | sed -e 's/^#\s*//'`
-
-                        if [ "x$f" = "xCODE_OF_CONDUCT.md" -o "x$f" = "xCONTRIBUTING.md" ] ; then
-                                # For some reason GitHub refuses to generate
-                                # HTML versions of these two documents,
-                                # probably because they are in some way special
-                                # in GitHub behaviour (as they are shown as
-                                # links in the issue submission form). Let's
-                                # work around this limitation by linking to
-                                # their repository browser version
-                                # instead. This might not even be such a bad
-                                # thing, given that the issue submission form
-                                # and our index file thus link to the same
-                                # version.
-                                u="https://github.com/systemd/systemd/blob/master/docs/$f"
-                        else
-                                u="https://systemd.io/"`echo "$f" | sed -e 's/.md$//'`
-                        fi
-                        echo "* [$t]($u)"
-                fi
-        done
-) > index.md