Skip to content

Commit 5e3c5ed

Browse files
cgwalterscgwalters
authored
Merge pull request #3 from nimbinatus/zola-build
Initiate landing site build
2 parents 593f402 + 001ca22 commit 5e3c5ed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+2363
-5
lines changed

‎.github/workflows/build.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Build site
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
pull_request:
7+
types:
8+
- opened
9+
- reopened
10+
- synchronize
11+
- closed
12+
13+
concurrency: preview-${{ github.ref }}
14+
15+
env:
16+
CARGO_TERM_COLOR: always
17+
18+
jobs:
19+
build_and_deploy:
20+
runs-on: ubuntu-latest
21+
if: github.ref == 'refs/heads/main'
22+
steps:
23+
- name: Check out repository
24+
uses: actions/checkout@v4
25+
- name: Build and deploy
26+
uses: shalzz/[email protected]
27+
env:
28+
PAGES_BRANCH: gh-pages
29+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
30+
preview:
31+
runs-on: ubuntu-latest
32+
if: github.ref != 'refs/heads/main'
33+
steps:
34+
- name: Checkout
35+
uses: actions/checkout@v4
36+
- name: Install and build
37+
if: github.event.action != 'closed'
38+
uses: shalzz/[email protected]
39+
env:
40+
BUILD_ONLY: true
41+
BUILD_FLAGS: --drafts
42+
BUILD_THEMES: false
43+
CHECK_LINKS: true

‎.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
site/public/
2+
.idea
3+
4+
.DS_Store

‎README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,26 @@
11
# This is the main site!
2+
3+
This site is built using [Zola](https://www.getzola.org/), a static site generator built with Rust. The theme is [Juice](https://www.getzola.org/themes/juice/).
4+
- Zola [Installation instructions](https://www.getzola.org/documentation/getting-started/installation/)
5+
- Juice [Installation info](https://juice.huhu.io/#installation) - Note that I've explicitly dropped the git history and VCS info from the theme directory.
6+
7+
Under the hood, Zola uses [Tera](https://keats.github.io/tera/) for templating.
8+
9+
## Structure
10+
11+
The site lives in the `site` directory. Content like pages or blog posts live in, appropriately, `content`. Any kind of image like screenshots would live in `static`.
12+
13+
The `templates` directory extends elements from the theme, which is stored in, appropriately, `themes/juice`.
14+
15+
## Building
16+
17+
Once you've installed Zola, proceed as follows:
18+
19+
```bash
20+
cd site
21+
zola serve
22+
```
23+
24+
Go to the URL for the webserver (likely `localhost:1111`) to explore the site.
25+
26+
You can also use `zola build` to build it once to the `public` directory if you so choose.

‎config.toml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
base_url = "https://bootc.dev"
2+
#base_url = "http://localhost"
3+
theme = "juice"
4+
title = "bootc"
5+
description = "A tool to build operating systems like we build containers"
6+
7+
default_language = "en"
8+
#languages =
9+
#translations =
10+
11+
# Whether to automatically compile all Sass files in the sass directory
12+
compile_sass = true
13+
14+
# Whether to build a search index to be used later on by a JavaScript library
15+
build_search_index = true
16+
17+
generate_feeds = true
18+
#feed_limit =
19+
feed_filenames = ["rss.xml"]
20+
21+
#hard_link_static =
22+
#taxonomies =
23+
#author =
24+
#compile_sass
25+
#minify_html
26+
#ignored_content
27+
#ignored_static
28+
#mode
29+
#output_dir
30+
#preserve_dotfiles_in_output
31+
#link_checker
32+
#slugify
33+
#search
34+
generate_sitemap = true
35+
generate_robots_txt = true
36+
#exclude_paginated_pages_in_sitemap
37+
38+
[markdown]
39+
# Whether to do syntax highlighting
40+
# Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola
41+
highlight_code = true
42+
highlight_theme = "inspired-github"
43+
render_emoji = true
44+
external_links_class = "external"
45+
external_links_target_blank = true
46+
external_links_no_referrer = true
47+
#insert_anchor_links = "left"
48+
49+
[extra]
50+
# Put all your custom variables here
51+
juice_logo_name = "bootc"
52+
juice_logo_path = "logo.png"
53+
juice_extra_menu = [
54+
{ title = "About", link = "/about", external = false },
55+
{ title = "Docs", link = "https://bootc-dev.github.io/bootc/", external = true },
56+
{ title = "News", link = "/news", external = false },
57+
{ title = "GitHub", link = "https://github.com/bootc-dev/bootc", external = true },
58+
]
59+
favicon = "favicon.ico"
60+
meta_title = "Your OS, but Containers!"
61+
meta_description = "bootc builds operating systems using containerization principles"
62+
footer = ""

‎content/_index.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: bootc
3+
---
4+
5+
Transactional, in-place operating system updates using OCI/Docker container images.
6+
7+
## Motivation
8+
9+
The original Docker container model of using "layers" to model applications has been extremely successful. This project aims to apply the same technique for bootable host systems - using standard OCI/Docker containers as a transport and delivery format for base operating system updates.
10+
11+
The container image includes a Linux kernel (in e.g. `/usr/lib/modules`), which is used to boot. At runtime on a target system, the base userspace is *not* itself running in a "container" by default. For example, assuming systemd is in use, systemd acts as pid1 as usual---there's no "outer" process. More about this in the docs; see below.
12+
13+
## Status
14+
15+
The CLI and API are considered stable. We will ensure that every existing system can be upgraded in place seamlessly across any future changes.
16+
17+
## Documentation
18+
19+
The project documentation is hosted on a different site: [Docs](https://bootc-dev.github.io/bootc/)
20+
21+
## Versioning
22+
23+
Although bootc is not released to crates.io as a library, version numbers are expected to follow [semantic versioning](https://semver.org/) standards. This practice began with the release of version 1.2.0; versions prior may not adhere strictly to semver standards.
24+
25+
## Adopters (base and end-user images)
26+
27+
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](about/adopters).
28+
29+
## Community discussion
30+
31+
- [Github discussion forum](https://github.com/containers/bootc/discussions) for async discussion
32+
- [#bootc-dev on CNCF Slack](https://cloud-native.slack.com/archives/C08SKSQKG1L) for live chat
33+
- Recurring live meeting hosted on [CNCF Zoom](https://zoom-lfx.platform.linuxfoundation.org/meeting/96540875093?password=7889708d-c520-4565-90d3-ce9e253a1f65) each Friday at 15:30 UTC.
34+
- [Meeting notes on HackMD](https://hackmd.io/@cgwalters/HJk3Aj0ree/edit)
35+
36+
This project is also currently tightly related to the previously mentioned Fedora/CentOS bootc project, and many developers monitor the relevant discussion forums there. In particular, there's a Matrix channel and a weekly chat meeting; [learn more](https://docs.fedoraproject.org/en-US/bootc/community/).
37+
38+
## Developing bootc
39+
40+
Are you interested in working on bootc? Great! Reference our [contribution guide](about/contributing).
41+
There is also a list of [Maintainers](about/maintainers).
42+
43+
## Governance
44+
Reference [Governance](about/governance) for project governance details.
45+
46+
## Badges
47+
48+
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/10113/badge)](https://www.bestpractices.dev/projects/10113)
49+
50+
### Code of Conduct
51+
52+
The bootc project is a [Cloud Native Computing Foundation (CNCF) Sandbox project](https://www.cncf.io/sandbox-projects/) and adheres to the [CNCF Community Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
53+
54+
---
55+
The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see [Trademark Usage](https://www.linuxfoundation.org/trademark-usage/).

‎content/about/_index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
+++
2+
title = "Project information"
3+
description = "About the project"
4+
weight = 1
5+
+++
6+
7+
Use these pages to learn more about the project, our governance, and adopters.

‎content/about/about.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
+++
2+
title = "About"
3+
description = "About bootc"
4+
weight = 1
5+
toc = true
6+
+++
7+
8+
# So what is bootc?
9+
10+
Imagine the ability to set up your operating system using a file you can check into source control. bootc basically turns your operating system into a containerized system, complete with in-place updates, custom configurations and pre-installed software and drivers, and more. You can share your custom containerized operating system image with others, too.
11+
12+
Unlock the power of bootc with shared custom OS images.

‎content/about/adopters.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
+++
2+
title = "Adopters"
3+
description = "End User Adopters"
4+
template = "imported.html"
5+
weight = 9
6+
toc = true
7+
[extra]
8+
fileimport = "ADOPTERS"
9+
+++
10+

‎content/about/changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
+++
2+
title = "Changelog"
3+
description = "Changelog"
4+
weight = 2
5+
+++

‎content/about/contributing.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
+++
2+
title = "Contributing"
3+
description = "Contributing"
4+
template = "imported.html"
5+
weight = 3
6+
toc = true
7+
[extra]
8+
fileimport = "CONTRIBUTING"
9+
+++
10+

0 commit comments

Comments
 (0)