From a0fadf66dabaf46b5f891356218deacc213fed02 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Tue, 14 Jan 2020 10:11:19 +0100 Subject: [PATCH 1/2] docs: drop "The" in categorization titles of Markdown documentation I think it makes sense to keep the "The" in place for the actual page's title, but let's drop it from the categorization header, to make it easier to find stuff, as the "The" isn't helpful to that. In particular as we sometimes do it this and sometimes the other way so far, hence let's stick to one common rule. --- docs/BOOT_LOADER_INTERFACE.md | 2 +- docs/BOOT_LOADER_SPECIFICATION.md | 2 +- docs/CODE_OF_CONDUCT.md | 2 +- docs/CONTAINER_INTERFACE.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/BOOT_LOADER_INTERFACE.md b/docs/BOOT_LOADER_INTERFACE.md index ba88fe72cc..e1ba815d34 100644 --- a/docs/BOOT_LOADER_INTERFACE.md +++ b/docs/BOOT_LOADER_INTERFACE.md @@ -1,5 +1,5 @@ --- -title: The Boot Loader Interface +title: Boot Loader Interface category: Booting layout: default --- diff --git a/docs/BOOT_LOADER_SPECIFICATION.md b/docs/BOOT_LOADER_SPECIFICATION.md index 59c87dd121..3d40df760b 100644 --- a/docs/BOOT_LOADER_SPECIFICATION.md +++ b/docs/BOOT_LOADER_SPECIFICATION.md @@ -1,5 +1,5 @@ --- -title: The Boot Loader Specification +title: Boot Loader Specification category: Booting layout: default --- diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index b0925691c9..b906bf5acb 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -1,5 +1,5 @@ --- -title: The systemd Community Conduct Guidelines +title: systemd Community Conduct Guidelines category: Contributing layout: default --- diff --git a/docs/CONTAINER_INTERFACE.md b/docs/CONTAINER_INTERFACE.md index fc5c0a06ed..71f9185c58 100644 --- a/docs/CONTAINER_INTERFACE.md +++ b/docs/CONTAINER_INTERFACE.md @@ -1,5 +1,5 @@ --- -title: The Container Interface +title: Container Interface category: Interfaces layout: default --- From b35ec8ded2da2b7a127bb1c831cd6b79c3ecb97a Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Tue, 14 Jan 2020 10:14:11 +0100 Subject: [PATCH 2/2] docs: uppercase all markdown document titles For most we used uppercasing, but not for all. Let's stick to one rule, and uppercase them all. --- docs/SECURITY.md | 4 ++-- docs/TESTING_WITH_SANITIZERS.md | 4 ++-- docs/TRANSIENT-SETTINGS.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/SECURITY.md b/docs/SECURITY.md index 05f9330561..0b34e5325f 100644 --- a/docs/SECURITY.md +++ b/docs/SECURITY.md @@ -1,9 +1,9 @@ --- -title: Reporting of security vulnerabilities +title: Reporting of Security Vulnerabilities category: Contributing layout: default --- -# Reporting of security vulnerabilities +# Reporting of Security Vulnerabilities If you discover a security vulnerability, we'd appreciate a non-public disclosure. The [issue tracker](https://github.com/systemd/systemd/issues) and [systemd-devel mailing list](https://lists.freedesktop.org/mailman/listinfo/systemd-devel) are fully public. If you need to reach systemd developers in a non-public way, report the issue to the [systemd-security@redhat.com](mailto:systemd-security@redhat.com) mailing list. The disclosure will be coordinated with distributions. diff --git a/docs/TESTING_WITH_SANITIZERS.md b/docs/TESTING_WITH_SANITIZERS.md index 4d58d0f2b2..2622682bd9 100644 --- a/docs/TESTING_WITH_SANITIZERS.md +++ b/docs/TESTING_WITH_SANITIZERS.md @@ -1,10 +1,10 @@ --- -title: Testing systemd using sanitizers +title: Testing systemd Using Sanitizers category: Contributing layout: default --- -# Testing systemd using sanitizers +# Testing systemd Using Sanitizers To catch the *nastier* kind of bugs, you can run your code with [Address Sanitizer](https://clang.llvm.org/docs/AddressSanitizer.html) and [Undefined Behavior Sanitizer](https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html). diff --git a/docs/TRANSIENT-SETTINGS.md b/docs/TRANSIENT-SETTINGS.md index e9122d5b2b..9f93e3b836 100644 --- a/docs/TRANSIENT-SETTINGS.md +++ b/docs/TRANSIENT-SETTINGS.md @@ -1,10 +1,10 @@ --- -title: What settings are currently available for transient units? +title: What Settings Are Currently Available For Transient Units? category: Interfaces layout: default --- -# 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 also available for transient units, through the D-Bus API. At the moment,