Skip to content

Docs updates#570

Open
nuclearcat wants to merge 9 commits into
mainfrom
docs-updates
Open

Docs updates#570
nuclearcat wants to merge 9 commits into
mainfrom
docs-updates

Conversation

@nuclearcat

Copy link
Copy Markdown
Member

No description provided.

@nuclearcat
nuclearcat force-pushed the docs-updates branch 2 times, most recently from a2d9a8b to 448101a Compare July 16, 2026 08:07
@patersonc

Copy link
Copy Markdown
Collaborator

/staging

@patersonc
patersonc self-requested a review July 16, 2026 09:58
@patersonc

Copy link
Copy Markdown
Collaborator

The staging deployment actions job doesn't seem happy: https://github.com/kernelci/kernelci-project/actions/runs/29489094118/job/87590577031

The /components/kcidb section was rendered from the old kernelci/kcidb
repository and still documented the retired Google Cloud submission flow
(Pub/Sub topics, BigQuery, Grafana at kcidb.kernelci.org).

Replace the git submodule with locally-authored pages describing the
current kcidb-ng REST submission procedure: JWT tokens, POST /submit,
ingester, hybrid submissions referencing Maestro builds, and kci-dev
for submitting and monitoring results.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
State upfront who the Maestro documentation is for: labs that want to
get connected to the pipeline and people self-hosting an instance.
Kernel developers looking for results are pointed to the dashboard and
kci-dev instead.

Update the staging instance links: the Docker log web interface and the
interactive API docs URLs are dead, replace them with the staging
control panel and the node viewer.  Fix the broken staging docs link in
the contribution guidelines.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
Drop the legacy BigQuery and Grafana service sections, gone with the
old Google-Cloud-based KCIDB.  Point the KCIDB software section at
kcidb-ng and kcidb-io and update the maintainer.  Remove the remaining
Jenkins-era wording from the API, Pipeline, VM servers, native tests
and IRC sections, and drop spbnick who is no longer a maintainer.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
The grafana.kernelci.org instance is no longer available.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
Drop the reference to the old Debian Buster rootfs and fix a stray
backtick.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
No page on the website is rendered from the kernelci-core repository
anymore, so stop cloning and updating it during deployment.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
Spell out that logs, images and other artifacts referenced in KCIDB
submissions are hosted by the submitter and must be publicly
accessible.  KernelCI foundation members can get assistance and file
hosting over kernelci-storage; for others this is discussed case by
case.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
Maestro now supports pull labs: the lab polls for jobs and sends
results back using only outbound connections, so it can run behind a
firewall and doesn't have to be LAVA based.  Update the platform
testing and architecture pages which still claimed firewalled labs
cannot connect to Maestro.

Also recommend in the KCIDB submitter guide that labs testing Maestro
kernels submit their results through Maestro rather than directly to
KCIDB, so the node hierarchy stays consistent.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
Explain when a new test suite fits Maestro (DUT-style suites that can be
baked into a rootfs, or builder-side jobs like KUnit and cvehound that
need community discussion due to compute costs) and when running your
own CI and submitting directly to KCIDB is the better option.  Point
new test authors at the job definitions, templates, scheduler and
platform configs in kernelci-pipeline and the rootfs recipes in
kernelci-core, with concrete examples to start from.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
@nuclearcat

Copy link
Copy Markdown
Member Author

/staging

@github-actions

Copy link
Copy Markdown

Your PR has been deployed to staging. Staging URL: https://static.staging.kernelci.org/ After testing, you can merge your PR. Note: This is a temporary staging URL, if anyone else will test another PR, it will override contents.

@nuclearcat
nuclearcat marked this pull request as ready for review July 16, 2026 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants