From 588fd73da5136444f692299056addc574a9fd8eb Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Tue, 22 Oct 2024 15:05:38 -0400 Subject: [PATCH] Add MAINTAINERS.md and ADOPTERS.md These files help clarify/formalize some information. In particular I'd like to look at tools that auto-sync from MAINTAINERS to the github permissions so that we can maintain that in a git-ops fashion. Signed-off-by: Colin Walters --- ADOPTERS.md | 37 +++++++++++++++++++++++++++++++++++++ MAINTAINERS.md | 9 +++++++++ README.md | 11 +++++++---- 3 files changed, 53 insertions(+), 4 deletions(-) create mode 100644 ADOPTERS.md create mode 100644 MAINTAINERS.md diff --git a/ADOPTERS.md b/ADOPTERS.md new file mode 100644 index 000000000..b8c3f3f87 --- /dev/null +++ b/ADOPTERS.md @@ -0,0 +1,37 @@ + +> **Note** +> Do you want to add yourself to this list? Simply fork the repository and open a PR with the required change. +> We have a short description of the adopter types at the bottom of this page. Each type is in alphabetical order. + +# bootc Adopters (direct) + +| Type | Name | Since | Website | Use-Case | +|:-|:-|:-|:-|:-| +Vendor | Red Hat | 2024 | https://redhat.com | Image Based Linux +End-User | HeliumOS | 2024 | https://www.heliumos.org/ | An atomic desktop operating system for your devices. + +# bootc Adopters (indirect, via ostree) + +Bootc is a relatively new project, but much of the underlying technology and goals is *not* new. +The underlying ostree project is over 13 years old (as of 2024). This project also relates +to [rpm-ostree](https://github.com/coreos/rpm-ostree/) which has existed a really long time. + +Not every one of these projects uses bootc directly today, but a toplevel goal of bootc +is to be the successor to ostree, and it is our aim to seamlessly carry forward these users. + +| Type | Name | Since | Website | Use-Case | +|:-|:-|:-|:-|:-| +| Vendor | Endless | 2014 | [link](https://www.endlessos.org/os) | A Completely Free, User-Friendly Operating System Packed with Educational Tools, Games, and More. +| Vendor | Apertis | 2020 | [link](https://apertis.org) | Collaborative OS platform for products +| Vendor | UBlue | 2023 | [link](https://universal-blue.org/) | The reliability of a Chromebook, but with the flexibility and power of a traditional Linux desktop. +| Vendor | Fedora Project | 2021 | [link](https://fedoraproject.org/atomic-desktops/) | An atomic desktop operating system aimed at good support for container-focused workflows. +| Vendor | Red Hat | 2015 | [link](https://redhat.com) | Image Based Linux + +### Adopter Types + +**End-user**: The organization runs bootc in production in some way. + +**Integration**: The organization has a product that integrates with bootc, but does not contain bootc. + +**Vendor**: The organization packages bootc in their product and sells it as part of their product. + diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 000000000..9b602b28c --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,9 @@ +# Maintainers + +The current Maintainers Group for the bootc Project consists of: + +| Name | GitHub ID | Employer | Responsibilities | +| ---- | ---- | ---- | ---- | +| Chris Kyrouac | [ckyrouac](https://github.com/orgs/containers/people/ckyrouac) | Red Hat | Approver | +| Colin Walters | [cgwalters](https://github.com/orgs/containers/people/cgwalters) | Red Hat | Approver | +| John Eckersberg | [jeckersb](https://github.com/orgs/containers/people/jeckersb) | Red Hat | Approver | diff --git a/README.md b/README.md index c320226ea..bde2c157a 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,13 @@ can be upgraded in place seamlessly across any future changes. ## Documentation -See the [project documentation](https://containers.github.io/bootc/); there -are also operating systems and distributions using bootc; here are some examples: +See the [project documentation](https://containers.github.io/bootc/). -- https://docs.fedoraproject.org/en-US/bootc/ -- https://www.heliumos.org/ +## Adopters (base and end-user images) + +The bootc CLI is just a client system; it is not tied to any particular +operating system or Linux distribution. You very likely want to actually +start by looking at [ADOPTERS.md](ADOPTERS.md). ## Community discussion @@ -41,4 +43,5 @@ Matrix channel and a weekly video call meeting for example: