summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2019-12-11 11:43:31 +0100
committerGitHub <noreply@github.com>2019-12-11 11:43:31 +0100
commitb65cb5cb7a0f72e2102cc6940e16c82bb790a1a2 (patch)
tree93223195d43d488a85f167654837c8baa6496ac6
parentf32d15b0e4f5a0d2c31b22cb66f690a158ae9dfd (diff)
parent5d3f5e4081964694dd08b9083c923a47eeff79e9 (diff)
downloadsystemd-b65cb5cb7a0f72e2102cc6940e16c82bb790a1a2.tar.gz
Merge pull request #14306 from poettering/markdown-category
beef up systemd.io pages with simple categorization
-rw-r--r--docs/AUTOMATIC_BOOT_ASSESSMENT.md1
-rw-r--r--docs/BLOCK_DEVICE_LOCKING.md1
-rw-r--r--docs/BOOT_LOADER_INTERFACE.md1
-rw-r--r--docs/BOOT_LOADER_SPECIFICATION.md1
-rw-r--r--docs/CGROUP_DELEGATION.md1
-rw-r--r--docs/CODE_OF_CONDUCT.md1
-rw-r--r--docs/CODE_QUALITY.md1
-rw-r--r--docs/CODING_STYLE.md1
-rw-r--r--docs/CONTRIBUTING.md1
-rw-r--r--docs/DISTRO_PORTING.md1
-rw-r--r--docs/ENVIRONMENT.md1
-rw-r--r--docs/HACKING.md1
-rw-r--r--docs/PORTABLE_SERVICES.md1
-rw-r--r--docs/PREDICTABLE_INTERFACE_NAMES.md1
-rw-r--r--docs/RANDOM_SEEDS.md1
-rw-r--r--docs/RELEASE.md1
-rw-r--r--docs/SECURITY.md1
-rw-r--r--docs/TEMPORARY_DIRECTORIES.md1
-rw-r--r--docs/TESTING_WITH_SANITIZERS.md1
-rw-r--r--docs/TRANSIENT-SETTINGS.md1
-rw-r--r--docs/TRANSLATORS.md1
-rw-r--r--docs/UIDS-GIDS.md1
-rw-r--r--docs/_data/extra_pages.json10
-rw-r--r--docs/index.md12
24 files changed, 41 insertions, 3 deletions
diff --git a/docs/AUTOMATIC_BOOT_ASSESSMENT.md b/docs/AUTOMATIC_BOOT_ASSESSMENT.md
index 1ef4bdcfe1..6df638417e 100644
--- a/docs/AUTOMATIC_BOOT_ASSESSMENT.md
+++ b/docs/AUTOMATIC_BOOT_ASSESSMENT.md
@@ -1,5 +1,6 @@
---
title: Automatic Boot Assessment
+category: Booting
---
# Automatic Boot Assessment
diff --git a/docs/BLOCK_DEVICE_LOCKING.md b/docs/BLOCK_DEVICE_LOCKING.md
index 5509b41942..491b22c95c 100644
--- a/docs/BLOCK_DEVICE_LOCKING.md
+++ b/docs/BLOCK_DEVICE_LOCKING.md
@@ -1,5 +1,6 @@
---
title: Locking Block Device Access
+category: Interfaces
---
# Locking Block Device Access
diff --git a/docs/BOOT_LOADER_INTERFACE.md b/docs/BOOT_LOADER_INTERFACE.md
index c0ed099845..4fe65467f9 100644
--- a/docs/BOOT_LOADER_INTERFACE.md
+++ b/docs/BOOT_LOADER_INTERFACE.md
@@ -1,5 +1,6 @@
---
title: The Boot Loader Interface
+category: Booting
---
# The Boot Loader Interface
diff --git a/docs/BOOT_LOADER_SPECIFICATION.md b/docs/BOOT_LOADER_SPECIFICATION.md
index 3bd300c24e..0bdf3570a8 100644
--- a/docs/BOOT_LOADER_SPECIFICATION.md
+++ b/docs/BOOT_LOADER_SPECIFICATION.md
@@ -1,5 +1,6 @@
---
title: The Boot Loader Specification
+category: Booting
---
# The Boot Loader Specification
diff --git a/docs/CGROUP_DELEGATION.md b/docs/CGROUP_DELEGATION.md
index 607ba6f810..1902c467ad 100644
--- a/docs/CGROUP_DELEGATION.md
+++ b/docs/CGROUP_DELEGATION.md
@@ -1,5 +1,6 @@
---
title: Control Group APIs and Delegation
+category: Interfaces
---
# Control Group APIs and Delegation
diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
index da290ecda3..30e966d29e 100644
--- a/docs/CODE_OF_CONDUCT.md
+++ b/docs/CODE_OF_CONDUCT.md
@@ -1,5 +1,6 @@
---
title: The systemd Community Conduct Guidelines
+category: Contributing
---
# The systemd Community Conduct Guidelines
diff --git a/docs/CODE_QUALITY.md b/docs/CODE_QUALITY.md
index a3bdfaad8e..28f262d1f2 100644
--- a/docs/CODE_QUALITY.md
+++ b/docs/CODE_QUALITY.md
@@ -1,5 +1,6 @@
---
title: Code Quality Tools
+category: Contributing
---
# Code Quality Tools
diff --git a/docs/CODING_STYLE.md b/docs/CODING_STYLE.md
index 3b9b5e6c46..c2eb902eb4 100644
--- a/docs/CODING_STYLE.md
+++ b/docs/CODING_STYLE.md
@@ -1,5 +1,6 @@
---
title: Coding Style
+category: Contributing
---
# Coding Style
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
index 565acdd1cb..9459a3fe82 100644
--- a/docs/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -1,5 +1,6 @@
---
title: Contributing
+category: Contributing
---
# Contributing
diff --git a/docs/DISTRO_PORTING.md b/docs/DISTRO_PORTING.md
index d14bf131ba..5d62a08c06 100644
--- a/docs/DISTRO_PORTING.md
+++ b/docs/DISTRO_PORTING.md
@@ -1,5 +1,6 @@
---
title: Porting systemd To New Distributions
+category: Concepts
---
# Porting systemd To New Distributions
diff --git a/docs/ENVIRONMENT.md b/docs/ENVIRONMENT.md
index a3837ebfdb..7d51e40011 100644
--- a/docs/ENVIRONMENT.md
+++ b/docs/ENVIRONMENT.md
@@ -1,5 +1,6 @@
---
title: Known Environment Variables
+category: Interfaces
---
# Known Environment Variables
diff --git a/docs/HACKING.md b/docs/HACKING.md
index 7dc1eb98cb..98139198c1 100644
--- a/docs/HACKING.md
+++ b/docs/HACKING.md
@@ -1,5 +1,6 @@
---
title: Hacking on systemd
+category: Contributing
---
# Hacking on systemd
diff --git a/docs/PORTABLE_SERVICES.md b/docs/PORTABLE_SERVICES.md
index 194ef5bcdb..7216f2105a 100644
--- a/docs/PORTABLE_SERVICES.md
+++ b/docs/PORTABLE_SERVICES.md
@@ -1,5 +1,6 @@
---
title: Portable Services Introduction
+category: Concepts
---
# Portable Services Introduction
diff --git a/docs/PREDICTABLE_INTERFACE_NAMES.md b/docs/PREDICTABLE_INTERFACE_NAMES.md
index b29016f93d..ff3d0fb3ad 100644
--- a/docs/PREDICTABLE_INTERFACE_NAMES.md
+++ b/docs/PREDICTABLE_INTERFACE_NAMES.md
@@ -1,5 +1,6 @@
---
title: Predictable Network Interface Names
+category: Concepts
---
# Predictable Network Interface Names
diff --git a/docs/RANDOM_SEEDS.md b/docs/RANDOM_SEEDS.md
index 926238a3ae..ef7df412dd 100644
--- a/docs/RANDOM_SEEDS.md
+++ b/docs/RANDOM_SEEDS.md
@@ -1,5 +1,6 @@
---
title: Random Seeds
+category: Concepts
---
# Random Seeds
diff --git a/docs/RELEASE.md b/docs/RELEASE.md
index 56debd68d2..3cb79fd182 100644
--- a/docs/RELEASE.md
+++ b/docs/RELEASE.md
@@ -1,5 +1,6 @@
---
title: Steps to a Successful Release
+category: Contributing
---
# Steps to a Successful Release
diff --git a/docs/SECURITY.md b/docs/SECURITY.md
index 93847dcd8e..a060e4547b 100644
--- a/docs/SECURITY.md
+++ b/docs/SECURITY.md
@@ -1,5 +1,6 @@
---
title: Reporting of security vulnerabilities
+category: Contributing
---
# Reporting of security vulnerabilities
diff --git a/docs/TEMPORARY_DIRECTORIES.md b/docs/TEMPORARY_DIRECTORIES.md
index 9271e0e478..1a27b795ce 100644
--- a/docs/TEMPORARY_DIRECTORIES.md
+++ b/docs/TEMPORARY_DIRECTORIES.md
@@ -1,5 +1,6 @@
---
title: Using /tmp/ And /var/tmp/ Safely
+category: Interfaces
---
# Using `/tmp/` And `/var/tmp/` Safely
diff --git a/docs/TESTING_WITH_SANITIZERS.md b/docs/TESTING_WITH_SANITIZERS.md
index 7cb879aaf3..6c3465aac2 100644
--- a/docs/TESTING_WITH_SANITIZERS.md
+++ b/docs/TESTING_WITH_SANITIZERS.md
@@ -1,5 +1,6 @@
---
title: Testing systemd using sanitizers
+category: Contributing
---
# Testing systemd using sanitizers
diff --git a/docs/TRANSIENT-SETTINGS.md b/docs/TRANSIENT-SETTINGS.md
index 6cbd03e1ad..549ec678fc 100644
--- a/docs/TRANSIENT-SETTINGS.md
+++ b/docs/TRANSIENT-SETTINGS.md
@@ -1,5 +1,6 @@
---
title: What settings are currently available for transient units?
+category: Interfaces
---
# What settings are currently available for transient units?
diff --git a/docs/TRANSLATORS.md b/docs/TRANSLATORS.md
index d155c1c875..f9e7105ac8 100644
--- a/docs/TRANSLATORS.md
+++ b/docs/TRANSLATORS.md
@@ -1,5 +1,6 @@
---
title: Notes for Translators
+category: Contributing
---
# Notes for Translators
diff --git a/docs/UIDS-GIDS.md b/docs/UIDS-GIDS.md
index 1f3966f4c0..d92b055fec 100644
--- a/docs/UIDS-GIDS.md
+++ b/docs/UIDS-GIDS.md
@@ -1,5 +1,6 @@
---
title: Users, Groups, UIDs and GIDs on `systemd` Systems
+category: Concepts
---
# Users, Groups, UIDs and GIDs on `systemd` Systems
diff --git a/docs/_data/extra_pages.json b/docs/_data/extra_pages.json
new file mode 100644
index 0000000000..5ede56c6fc
--- /dev/null
+++ b/docs/_data/extra_pages.json
@@ -0,0 +1,10 @@
+[
+ { "category": "Project", "title": "Brand", "url": "https://brand.systemd.io/" },
+ { "category": "Project", "title": "Releases", "url": "https://github.com/systemd/systemd/releases" },
+ { "category": "Project", "title": "GitHub Project Page", "url": "https://github.com/systemd/systemd" },
+ { "category": "Project", "title": "Issues", "url": "https://github.com/systemd/systemd/issues" },
+ { "category": "Project", "title": "Pull Requests", "url": "https://github.com/systemd/systemd/pulls" },
+ { "category": "Project", "title": "Mailing List", "url": "https://lists.freedesktop.org/mailman/listinfo/systemd-devel" },
+ { "category": "Manual Pages", "title": "Index", "url": "https://www.freedesktop.org/software/systemd/man/" },
+ { "category": "Manual Pages", "title": "Directives", "url": "https://www.freedesktop.org/software/systemd/man/systemd.directives.html" }
+]
diff --git a/docs/index.md b/docs/index.md
index ffb30b9634..2969162a2a 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -4,8 +4,14 @@ title: systemd Documentation
# systemd Documentation
-{% for p in site.pages %}
- {% if p.url != page.url and p.title %}
-* [{{ p.title }}]({{ p.url | relative_url }})
+{% assign by_category = site.pages | group_by:"category" %}
+{% assign extra_pages = site.data.extra_pages | group_by:"category" %}
+{% assign merged = by_category | concat: extra_pages | sort:"name" %}
+
+{% for pair in merged %}
+ {% if pair.name != "" %}
+## {{ pair.name }}
+{% assign sorted = pair.items | sort:"title" %}{% for page in sorted %}
+* [{{ page.title }}]({{ page.url | relative_url }}){% endfor %}
{% endif %}
{% endfor %}