Skip to content

Commit

Permalink
docs: create new high level landing page
Browse files Browse the repository at this point in the history
We want to direct different users to different parts of
the documentation. Our documentation has a few different
audiences and that was not clear in the landing page.

Signed-off-by: Gustavo Padovan <[email protected]>
  • Loading branch information
padovan authored and patersonc committed Jul 8, 2024
1 parent c0ea98b commit d0df9fe
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 27 deletions.
60 changes: 33 additions & 27 deletions kernelci.org/content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,30 +11,36 @@ cascade:
path: "/**"
---

Welcome to the KernelCI documentation website. You'll find below a summary of
the overall architecture and pointers to the main sections.

## Overall Architecture

![architecture](/image/kernelci-architecture.png)

The first thing worth noting here is that there are two main parts of the
overall KernelCI architecture:

### [API & Pipeline](api_pipeline)

The top half of this picture shows native services interacting directly with
the API: LAVA test labs, Kubernetes clusters, custom test environments and the
job scheduler. These are referred to as the KernelCI Pipeline in a loose
sense. Such services can be run pretty much anywhere, they are just API
clients with a particular purpose.

### [KCIDB](kcidb)

Other fully autonomous systems producing their own kernel builds and running
their own tests can submit results to
[KCIDB](kcidb), which is a
[BigQuery](https://cloud.google.com/bigquery) database to provide a unified
kernel test reporting mechanism. Please take a look at this blog post for a
comprehensive description: [Introducing Common
Reporting](https://kernelci.org/blog/2020/08/21/introducing-common-reporting/).
Welcome to the KernelCI documentation website.


<div class="container border border-primary rounded p-2">
<h2 class="text-center">
<a href="kernel-community">Kernel Community</a>
</h2>
<p class="text-center">Start here if you are Kernel developer/maintainer
and want to add your tree and tests.</p>
</div>

<div class="container border border-primary rounded p-2 mt-3">
<h2 class="text-center">
<a href="labs">Labs</a>
</h2>
<p class="text-center">Start here if you want to add a lab to run KernelCI tests.</p>
</div>

<div class="container border border-primary rounded p-2 mt-3">
<h2 class="text-center">
<a href="kcidb">KCIDB</a>
</h2>
<p class="text-center">Start here if you want
to contribute your results to the KernelCI common database. KCIDB can receive tests results from any CI system.</p>
</div>

<div class="container border border-primary rounded p-2 mt-3">
<h2 class="text-center">
<a href="architecture">Contributing to KernelCI</a>
</h2>
<p class="text-center">Start here if you want to contribute to KernelCI and learn
more about our <a href="architecture">technical architecture</a>.</p>
</div>
28 changes: 28 additions & 0 deletions kernelci.org/content/en/architecture/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "KernelCI Architecture"
date: 2024-07-03
description: "Learn the inner details behind the KernelCI systems"
---

![architecture](/image/kernelci-architecture.png)

The first thing worth noting here is that there are two main parts of the
overall KernelCI architecture:

### [API & Pipeline](../api_pipeline)

The top half of this picture shows native services interacting directly with
the API: LAVA test labs, Kubernetes clusters, custom test environments and the
job scheduler. These are referred to as the KernelCI Pipeline in a loose
sense. Such services can be run pretty much anywhere, they are just API
clients with a particular purpose.

### [KCIDB](../kcidb)

Other fully autonomous systems producing their own kernel builds and running
their own tests can submit results to
[KCIDB](../kcidb), which is a
[BigQuery](https://cloud.google.com/bigquery) database to provide a unified
kernel test reporting mechanism. Please take a look at this blog post for a
comprehensive description: [Introducing Common
Reporting](https://kernelci.org/blog/2020/08/21/introducing-common-reporting/).

0 comments on commit d0df9fe

Please sign in to comment.