Skip to content

Commit

Permalink
Docs fixups (#1468)
Browse files Browse the repository at this point in the history
Signed-off-by: Ettore Di Giacinto <edigiacinto@suse.com>
  • Loading branch information
mudler authored Jun 1, 2022
1 parent b13694f commit 1eba88d
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
12 changes: 6 additions & 6 deletions docs/content/en/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<div>
<h1>Immutable Linux Derivatives at your fingertips</h1>
<div>
<h4>cOS is a toolkit to build, ship and maintain cloud-init driven Linux derivatives with containers..</h4>
<h4>Elemental is a toolkit to build, ship and maintain cloud-init driven Linux derivatives with containers..</h4>
</div>
<a href="docs/" class="btn" target="_blank" rel="noopener">Learn More</a>
</div>
Expand All @@ -32,23 +32,23 @@ <h5>True DevOps</h5>
</section>

<section class="wrap">
<h2>Why Use cOS toolkit ?</h2>
<h2>Why Use Elemental toolkit ?</h2>
<div class="grid-four">
<div>
<h5>Built for DevOps</h5>
<p>cOS toolkit allows to maintain custom Linux derivatives in a GitOps style with container registries.</p>
<p>Elemental toolkit allows to maintain custom Linux derivatives in a GitOps style with container registries.</p>
</div>
<div>
<h5>Operational Happiness</h5>
<p>Upgrade machines from container images in OTA style - manually or automatically within kubernetes.</p>
</div>
<div>
<h5>Bring your own OS</h5>
<p>A common featureset shared between cOS derivatives, completely pluggable.</p>
<p>A common featureset shared between Elemental derivatives, completely pluggable.</p>
</div>
<div>
<h5>Single Image OS</h5>
<p>cOS derivatives are single container image OS that are bootable from a system. They follow an OTA update style and gets upgrades from regular container registries.</p>
<p>derivatives built with Elemental are single container image OS that are bootable from a system. They follow an A/B update style and gets upgrades from regular container registries.</p>
</div>
</div>
</section>
Expand Down Expand Up @@ -89,7 +89,7 @@ <h4>Step 3.<br/><tt>elemental upgrade example</tt></h4>
<h2>Learn More</h2>
<p class="text-center">Ready to upgrade?</p>
<div class="text-center">
<a href="https://github.com/rancher/elemental-toolkit" target="blank" class="btn">Build with cOS toolkit today</a>
<a href="https://github.com/rancher/elemental-toolkit" target="blank" class="btn">Build with Elemental toolkit today</a>
</div>
</div>
</div>
Expand Down
16 changes: 8 additions & 8 deletions docs/content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ menu:
weight: 20
---

## What is cOS?
## What is Elemental toolkit?

cOS is a toolkit which allows container images to be bootable in VMs, baremetals, embedded devices, and much more.
Elemental is a toolkit which allows container images to be bootable in VMs, baremetals, embedded devices, and much more.

cOS allows to create meta-Linux derivatives which are configured throughout cloud-init configuration files and are immutable by default.
Elemental allows to create meta-Linux derivatives which are configured throughout cloud-init configuration files and are immutable by default.

cOS and derivatives shares a common feature set, can be upgraded with a A/B mechanism, and upgrades are delivered with standard container registries.
Elemental and derivatives shares a common feature set, can be upgraded with a A/B mechanism, and upgrades are delivered with standard container registries.

cOS comes also with vanilla images that can be used to boot directly container images built with the toolkit.
Elemental comes also with vanilla images that can be used to boot directly container images built with the toolkit.

## Why cOS?
## Why Elemental?

cOS allows to create custom OS versions in your cluster with standard container images with a high degree of customization. It can also be used in its vanilla form - cOS enables then everyone to build their own derivative and access it in various formats.
Elemental allows to create custom OS versions in your cluster with standard container images with a high degree of customization. It can also be used in its vanilla form - Elemental enables then everyone to build their own derivative and access it in various formats.

To build a bootable image is as simple as running `docker build`.

Expand All @@ -38,7 +38,7 @@ To build a bootable image is as simple as running `docker build`.
- Easy to customize
- Cryptographically verified
- instant switch from different versions
- recovery mechanism with `cOS` vanilla images (or bring your own)
- recovery mechanism with `Elemental` vanilla images (or bring your own)

## Mission

Expand Down
2 changes: 1 addition & 1 deletion make/Makefile.docs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
#

export BASE_URL?=https://rancher-sandbox.github.io/cOS-toolkit/
export BASE_URL?=https://rancher.github.io/elemental-toolkit/

docs-deps: $(LUET) $(HUGO) $(YQ)

Expand Down

0 comments on commit 1eba88d

Please sign in to comment.