From 4ae50658440e19be5d3d8470c2fadb0fa3dcfecc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Ravier?= Date: Sat, 24 Feb 2024 16:36:23 +0100 Subject: [PATCH 1/2] 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 --- docs/CONTRIBUTING.md | 3 ++- docs/adapting-existing.md | 3 ++- docs/atomic-rollbacks.md | 3 ++- docs/atomic-upgrades.md | 3 ++- docs/authenticated-repos.md | 3 ++- docs/bootloaders.md | 3 ++- docs/buildsystem-and-repos.md | 3 ++- docs/composefs.md | 3 ++- docs/contributing-tutorial.md | 3 ++- docs/deployment.md | 3 ++- docs/formats.md | 3 ++- docs/ima.md | 3 ++- docs/index.md | 3 ++- docs/introduction.md | 3 ++- docs/related-projects.md | 3 ++- docs/repo.md | 3 ++- docs/repository-management.md | 3 ++- docs/var.md | 3 ++- 18 files changed, 36 insertions(+), 18 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index b41e948491..3574c9e2aa 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,7 +1,6 @@ --- nav_order: 190 --- - # Contributing {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 190 1. TOC {:toc} + + ## Submitting patches A majority of current maintainers prefer the GitHub pull request diff --git a/docs/adapting-existing.md b/docs/adapting-existing.md index c477fb14ff..a1b738dcd7 100644 --- a/docs/adapting-existing.md +++ b/docs/adapting-existing.md @@ -1,7 +1,6 @@ --- nav_order: 70 --- - # Adapting existing mainstream distributions {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 70 1. TOC {:toc} + + ## System layout First, OSTree encourages systems to implement diff --git a/docs/atomic-rollbacks.md b/docs/atomic-rollbacks.md index 89e882b473..5091ee8036 100644 --- a/docs/atomic-rollbacks.md +++ b/docs/atomic-rollbacks.md @@ -1,7 +1,6 @@ --- nav_order: 60 --- - # Atomic Rollbacks {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 60 1. TOC {:toc} + + ## Automatic rollbacks See [greenboot](https://github.com/fedora-iot/greenboot/blob/main/README.md) for information on automatic rollbacks and how to integrate diff --git a/docs/atomic-upgrades.md b/docs/atomic-upgrades.md index 777a1fa004..27e02a7e6b 100644 --- a/docs/atomic-upgrades.md +++ b/docs/atomic-upgrades.md @@ -1,7 +1,6 @@ --- nav_order: 50 --- - # Atomic Upgrades {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 50 1. TOC {:toc} + + ## You can turn off the power anytime you want... OSTree is designed to implement fully atomic and safe upgrades; diff --git a/docs/authenticated-repos.md b/docs/authenticated-repos.md index 528bdd6862..31a0e89a61 100644 --- a/docs/authenticated-repos.md +++ b/docs/authenticated-repos.md @@ -1,7 +1,6 @@ --- nav_order: 100 --- - # Handling access to authenticated remote repositories {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 100 1. TOC {:toc} + + 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 diff --git a/docs/bootloaders.md b/docs/bootloaders.md index 03e017915a..6dd1e104ee 100644 --- a/docs/bootloaders.md +++ b/docs/bootloaders.md @@ -1,7 +1,6 @@ --- nav_order: 120 --- - # Bootloaders {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 120 1. TOC {:toc} + + ## 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. diff --git a/docs/buildsystem-and-repos.md b/docs/buildsystem-and-repos.md index 6141d83baf..2f49015ad3 100644 --- a/docs/buildsystem-and-repos.md +++ b/docs/buildsystem-and-repos.md @@ -1,7 +1,6 @@ --- nav_order: 90 --- - # Writing a buildsystem and managing repositories {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 90 1. TOC {:toc} + + 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 diff --git a/docs/composefs.md b/docs/composefs.md index 54469a9b20..af9544020d 100644 --- a/docs/composefs.md +++ b/docs/composefs.md @@ -1,7 +1,6 @@ --- nav_order: 110 --- - # Using composefs with OSTree {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 110 1. TOC {:toc} + + ## composefs The [composefs](https://github.com/containers/composefs) project is a new diff --git a/docs/contributing-tutorial.md b/docs/contributing-tutorial.md index d2972297b0..e6172cfc9c 100644 --- a/docs/contributing-tutorial.md +++ b/docs/contributing-tutorial.md @@ -1,7 +1,6 @@ --- nav_order: 200 --- - # OSTree Contributing Tutorial {: .no_toc } @@ -11,6 +10,8 @@ The following guide is about OSTree forking, building, adding a command, testing 1. TOC {:toc} + + ## Getting Started Fork https://github.com/ostreedev/ostree, then run the following commands. diff --git a/docs/deployment.md b/docs/deployment.md index d9c44c7aa1..03d885c74d 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -1,7 +1,6 @@ --- nav_order: 40 --- - # Deployments {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 40 1. TOC {:toc} + + ## Overview Built on top of the OSTree versioning filesystem core is a layer diff --git a/docs/formats.md b/docs/formats.md index e607b9864b..cd836203d6 100644 --- a/docs/formats.md +++ b/docs/formats.md @@ -1,7 +1,6 @@ --- nav_order: 80 --- - # OSTree data formats {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 80 1. TOC {:toc} + + ## On the topic of "smart servers" One really crucial difference between OSTree and git is that git has a diff --git a/docs/ima.md b/docs/ima.md index fc7daf99ee..34042a72ac 100644 --- a/docs/ima.md +++ b/docs/ima.md @@ -1,7 +1,6 @@ --- nav_order: 110 --- - # Using Linux IMA with OSTree {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 110 1. TOC {:toc} + + ## Linux IMA The [Linux Integrity Measurement Architecture](https://sourceforge.net/p/linux-ima/wiki/Home/) diff --git a/docs/index.md b/docs/index.md index e20cb79c31..6fda56ec7e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,6 @@ --- nav_order: 10 --- - # libostree {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 10 1. TOC {:toc} + + 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 diff --git a/docs/introduction.md b/docs/introduction.md index 855cded945..a4b8d2906d 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,7 +1,6 @@ --- nav_order: 20 --- - # OSTree Overview {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 20 1. TOC {:toc} + + ## Introduction OSTree is an upgrade system for Linux-based operating systems that diff --git a/docs/related-projects.md b/docs/related-projects.md index e4c21185d2..2c3c2b4ce6 100644 --- a/docs/related-projects.md +++ b/docs/related-projects.md @@ -1,7 +1,6 @@ --- nav_order: 110 --- - # Related Projects {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 110 1. TOC {:toc} + + 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), diff --git a/docs/repo.md b/docs/repo.md index a5c746ef89..871477b92f 100644 --- a/docs/repo.md +++ b/docs/repo.md @@ -1,7 +1,6 @@ --- nav_order: 30 --- - # Anatomy of an OSTree repository {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 30 1. TOC {:toc} + + ## Core object types and data model OSTree is deeply inspired by git; the core layer is a userspace diff --git a/docs/repository-management.md b/docs/repository-management.md index 07594f5310..87f1f7f9be 100644 --- a/docs/repository-management.md +++ b/docs/repository-management.md @@ -1,7 +1,6 @@ --- nav_order: 100 --- - # Managing content in OSTree repositories {: .no_toc } @@ -9,6 +8,8 @@ nav_order: 100 1. TOC {:toc} + + 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". diff --git a/docs/var.md b/docs/var.md index 44ee375eec..9ee3c4ad06 100644 --- a/docs/var.md +++ b/docs/var.md @@ -1,7 +1,6 @@ --- nav_order: 70 --- - # OSTree and /var handling @@ -10,6 +9,8 @@ nav_order: 70 1. TOC {:toc} + + ## Default commit/image /var handling As of OSTree 2024.3, when a commit is "deployed" (queued to boot), From a63f9516018c35bba6eef0503b972cf253a3f8fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Ravier?= Date: Sat, 24 Feb 2024 16:37:48 +0100 Subject: [PATCH 2/2] docs: Cleanup title for historical OSTree README --- docs/README-historical.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/README-historical.md b/docs/README-historical.md index f185e86509..b7292e98e0 100644 --- a/docs/README-historical.md +++ b/docs/README-historical.md @@ -1,16 +1,15 @@ --- nav_order: 990 -title: Historical OSTree README --- + +# Historical OSTree README + **This file is outdated, but some of the text here is still useful for historical context. I'm preserving it (explicitly still in the tree) for posterity.** -OSTree -====== - Problem statement -----------------