Skip to content

Commit 2a40d22

Browse files
nimbinatusnimbinatus
committed
feat(kickoff): set up new site with Zola
Signed-off-by: Laura Santamaria <[email protected]>
1 parent 593f402 commit 2a40d22

22 files changed

+367
-0
lines changed

‎.gitignore‎

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

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
11
# This is the main site!
2+
3+
This site is built using [Zola](https://www.getzola.org/), a static site generator build 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
6+
7+
Under the hood, Zola uses [Tera](https://keats.github.io/tera/) for templating.

‎site/config.toml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
#base_url = "https://bootc-dev.github.io"
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_target_blank = true
45+
external_links_no_referrer = true
46+
47+
[extra]
48+
# Put all your custom variables here
49+
juice_logo_name = "bootc"
50+
juice_logo_path = "logo.png"
51+
juice_extra_menu = [
52+
{ title = "About", link = "/about" },
53+
{ title = "Docs", link = "https://bootc-dev.github.io/bootc/" },
54+
{ title = "News", link = "/news" },
55+
{ title = "GitHub", link = "https://github.com/bootc-dev/bootc" },
56+
]
57+
favicon = "favicon.ico"
58+
meta_title = "Your OS, but Containers!"
59+
meta_description = "bootc builds operating systems using containerization principles"
60+
footer = "bootc, open sourced by Red Hat with <3 (c) the bootc project"

‎site/content/_index.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
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: [https://bootc-dev.github.io/bootc/](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 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 checking [Adopters](about/adopters).
28+
29+
## Community discussion
30+
31+
Github discussion forum for async discussion
32+
#bootc-dev on CNCF Slack for live chat
33+
This project is also 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 video call meeting for example: https://docs.fedoraproject.org/en-US/bootc/community/.
34+
35+
## Developing bootc
36+
37+
Are you interested in working on bootc? Great! Reference our [contribution guide](about/contributing). There is also a [list of maintainers](about/maintainers).
38+
39+
## Governance
40+
41+
Check [Governance for project governance details](about/governance).
42+
43+
## Badges
44+
45+
OpenSSF Best Practices
46+
47+
## Code of Conduct
48+
49+
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).
50+
51+
## Trademarks
52+
53+
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/).

‎site/content/about/_index.md‎

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

‎site/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 configuations 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

‎site/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+

‎site/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+
+++

‎site/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+

‎site/content/about/governance.md‎

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

0 commit comments

Comments
 (0)