https://github.com/kernelci/kernelci-project
KernelCI Linux Foundation project documentation
https://github.com/kernelci/kernelci-project
Last synced: about 1 year ago
JSON representation
KernelCI Linux Foundation project documentation
- Host: GitHub
- URL: https://github.com/kernelci/kernelci-project
- Owner: kernelci
- Created: 2021-01-27T13:12:58.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-21T11:24:55.000Z (almost 2 years ago)
- Last Synced: 2024-06-25T15:54:53.534Z (almost 2 years ago)
- Language: HTML
- Size: 6.48 MB
- Stars: 9
- Watchers: 26
- Forks: 25
- Open Issues: 106
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
KernelCI project
================
KernelCI is a Linux Foundation project dedicated to testing the upstream [Linux
kernel](https://kernel.org).
Mission statement:
> To ensure the quality, stability and long-term maintenance of the Linux
> kernel by maintaining an open ecosystem around test automation practices and
> principles.
This repository contains general documentation about the project.
Documentation website
=====================
The source code of [docs.kernelci.org](https://docs.kernelci.org) static pages is
contained in the [`kernelci.org`](kernelci.org) directory. It uses the
[Hugo](https://gohugo.io) framework.
To set up a local development server with Docker:
```sh
$ git clone https://github.com/kernelci/kernelci-project.git
$ cd kernelci-project
$ sudo apt install -y git-lfs
$ git-lfs fetch
$ git-lfs checkout
$ git submodule update --init --recursive
$ cd kernelci.org
```
Then to start the server:
```sh
$ docker run -v $PWD:/src -p 1313:1313 klakegg/hugo:0.97.3-ext-debian server -D
```
Alternatively, this can be started with `docker-compose`:
```sh
docker-compose up
```
Then open http://localhost:1313 in your browser.
Secrets and git-crypt
=====================
The [`secrets`](https://github.com/kernelci/kernelci-project/tree/main/secrets)
directory contains encrypted files with credentials used by the KernelCI
project. See the [Secrets](https://docs.kernelci.org/admin/secrets/) page for
more details about how it is used.