docs: Move SPDX identifiers under first title

Having a comment right before the first title apparently confuses
Jekyll.

Fixes: https://github.com/ostreedev/ostree/pull/3185
This commit is contained in:
Timothée Ravier 2024-02-24 16:36:23 +01:00
parent cdb4cad46d
commit 4ae5065844
18 changed files with 36 additions and 18 deletions

View 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

View 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

View 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

View 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;

View 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

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

View 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

View 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

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

View 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

View 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

View 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/)

View 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

View 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

View 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),

View 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

View 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".

View 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),