docs: Move SPDX identifiers under first title
authorTimothée Ravier <tim@siosm.fr>
Sat, 24 Feb 2024 15:36:23 +0000 (16:36 +0100)
committerTimothée Ravier <tim@siosm.fr>
Sat, 24 Feb 2024 15:39:19 +0000 (16:39 +0100)
Having a comment right before the first title apparently confuses
Jekyll.

Fixes: https://github.com/ostreedev/ostree/pull/3185
18 files changed:
docs/CONTRIBUTING.md
docs/adapting-existing.md
docs/atomic-rollbacks.md
docs/atomic-upgrades.md
docs/authenticated-repos.md
docs/bootloaders.md
docs/buildsystem-and-repos.md
docs/composefs.md
docs/contributing-tutorial.md
docs/deployment.md
docs/formats.md
docs/ima.md
docs/index.md
docs/introduction.md
docs/related-projects.md
docs/repo.md
docs/repository-management.md
docs/var.md

index b41e9484911247f14802593e89395553a95f6daf..3574c9e2aa507a3f0150fb44e8bd028901da6c21 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 190
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Contributing
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 190
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 ## Submitting patches
 
 A majority of current maintainers prefer the GitHub pull request
index c477fb14fffdaa4ae6d01499f2ddd022eb3f5314..a1b738dcd79bc3d2f9b9ffa283b542f200932d75 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 70
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Adapting existing mainstream distributions
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 70
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 ## System layout
 
 First, OSTree encourages systems to implement
index 89e882b4733984dd2853995830d496dc02112b5f..5091ee8036a1c0472cb867fab1c4ac38d89f23b3 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 60
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Atomic Rollbacks
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 60
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 ## Automatic rollbacks
 
 See [greenboot](https://github.com/fedora-iot/greenboot/blob/main/README.md) for information on automatic rollbacks and how to integrate
index 777a1fa00435d71f7b0e753e866c7764f967912a..27e02a7e6b005872c59869dad3e95735173ede8d 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 50
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Atomic Upgrades
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 50
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 ## You can turn off the power anytime you want...
 
 OSTree is designed to implement fully atomic and safe upgrades;
index 528bdd68622e36f4d039344064de29fb1254154f..31a0e89a61a56089550e111814dc89f52c9cf83f 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 100
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Handling access to authenticated remote repositories
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 100
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 There is no default concept of an "ostree server"; ostree expects to talk to a generic webserver, so any tool and technique applicable for generic HTTP can also apply to fetching content via OSTree's builtin HTTP client.
 
 ## Using mutual TLS
index 03e017915a027416857d2a7f725a14725ea83fa2..6dd1e104ee73e9bbe01e5c47b0bd9338a0bc27fb 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 120
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Bootloaders
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 120
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 ## OSTree and bootloaders
 
 The intended design of OSTree is that it just writes new files into `/boot/loader/entries`.  There is a legacy GRUB script (shipped on Fedora as `ostree-grub2`) that is intended only for the cases where the system GRUB does not support the `blscfg` verb.
index 6141d83baf0fc7b907e2880ce6279d8cccb33033..2f49015ad3a3e7a4ba3ea5264d2dbd9cc7b6303c 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 90
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Writing a buildsystem and managing repositories
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 90
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 OSTree is not a package system.  It does not directly support building
 source code.  Rather, it is a tool for transporting and managing
 content, along with package-system independent aspects like bootloader
index 54469a9b20f7754e1412c702805ae5f8ca274574..af9544020dacd6cb81a99b4f559b5d4c5ed61730 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 110
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Using composefs with OSTree
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 110
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 ## composefs
 
 The [composefs](https://github.com/containers/composefs) project is a new
index d2972297b0009990f1f62a608e83af9f61148d63..e6172cfc9c464f53cc22de6fe3c8bf58c56d9303 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 200
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # OSTree Contributing Tutorial
 {: .no_toc }
@@ -11,6 +10,8 @@ The following guide is about OSTree forking, building, adding a command, testing
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 ## Getting Started
 
 Fork https://github.com/ostreedev/ostree, then run the following commands.
index d9c44c7aa19cfef19455350cf4b1f3660aa20f52..03d885c74d222a6e63c89622182802e7ea7ee9b8 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 40
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Deployments
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 40
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 ## Overview
 
 Built on top of the OSTree versioning filesystem core is a layer
index e607b9864b687cdd131d9f2b4e490456b1803eca..cd836203d6c5955c48852b58dba4769094cf02b5 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 80
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # OSTree data formats
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 80
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 ## On the topic of "smart servers"
 
 One really crucial difference between OSTree and git is that git has a
index fc7daf99ee2c38aeb4d8160a32ddc99d99dd4ad9..34042a72ac01ac4b3c18a6c8577b50bdf330f2a1 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 110
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Using Linux IMA with OSTree
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 110
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 ## Linux IMA
 
 The [Linux Integrity Measurement Architecture](https://sourceforge.net/p/linux-ima/wiki/Home/)
index e20cb79c3159332f6db77656bd5141ea291feb1e..6fda56ec7ea7934d9bc3fe5454457b0277b0cb8a 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 10
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # libostree
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 10
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 This project is now known as "libostree", though it is still appropriate to use
 the previous name: "OSTree" (or "ostree"). The focus is on projects which use
 libostree's shared library, rather than users directly invoking the command line
index 855cded94594c331e12398a2e640f37616f0038f..a4b8d2906d8b3457e19062b069979e03895a620e 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 20
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # OSTree Overview
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 20
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 ## Introduction
 
 OSTree is an upgrade system for Linux-based operating systems that
index e4c21185d2158be7d0e45b2cb7bee94ecaec6996..2c3c2b4ce63770b869655aa8788fcc6b0937f96b 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 110
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Related Projects
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 110
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 OSTree is in many ways very evolutionary.  It builds on concepts and
 ideas introduced from many different projects such as
 [Systemd Stateless](http://0pointer.net/blog/projects/stateless.html),
index a5c746ef8982b9fc44f1e4be429f478baafdef4e..871477b92fa482eda72d5c3c668451d2fb1eec58 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 30
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Anatomy of an OSTree repository
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 30
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 ## Core object types and data model
 
 OSTree is deeply inspired by git; the core layer is a userspace
index 07594f531024bf1c0919ce292176731aa3948a9c..87f1f7f9be5c9e0b589640ad12e22a1439b69de6 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 100
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Managing content in OSTree repositories
 {: .no_toc }
@@ -9,6 +8,8 @@ nav_order: 100
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 Once you have a build system going, if you actually want client
 systems to retrieve the content, you will quickly feel a need for
 "repository management".
index 44ee375eec5414751733436f553297db13784e70..9ee3c4ad06995c522fd3461c60c2564c29716d7e 100644 (file)
@@ -1,7 +1,6 @@
 ---
 nav_order: 70
 ---
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # OSTree and /var handling
 
@@ -10,6 +9,8 @@ nav_order: 70
 1. TOC
 {:toc}
 
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 ## Default commit/image /var handling
 
 As of OSTree 2024.3, when a commit is "deployed" (queued to boot),