Skip to content

docs: add the public testing dashboard page - #3846

Open
OlufemiAdeOlusile wants to merge 1 commit into
masterfrom
feat/dashboard-page
Open

OlufemiAdeOlusile wants to merge 1 commit into
masterfrom
feat/dashboard-page

Conversation

@OlufemiAdeOlusile

Copy link
Copy Markdown
Collaborator

The public testing dashboard had no home: its page was carried inside the testing-results-cache service and served from the cache host. On the 2026-11-10 sync we agreed that the static front end is hosted on GitHub Pages from this repository, and the cache stays the back end that publishes the data.

This adds the page under src_docs/source/extra/dashboard/, three static files with no build step, and lists that folder in html_extra_path, so the docs build copies it into the site root and the page is served at /dashboard/ next to the documentation. The page reads its data URL from one meta tag in index.html; nothing else in it points at the cache. The data, dashboard.json, is built by the cache after each stats upload (mkoura/testing-results-cache#27 and #28) and served with a CORS header for this site's origin.

Tested by building the docs with the docs dependency group: the site root still holds the documentation index and CNAME, and dashboard/index.html, dashboard.css and dashboard.js sit beside them. The built site was served locally on one origin with the meta tag pointed at a local cache on another origin, behind a Caddy that sends the CORS header; the page fetched the data across origins and rendered two real runs, a smoke regression and a three-step upgrade of 5,529 tests, with the issues panel and the charts. Lint is green.

To deploy: set the meta tag to the cache's public dashboard host, publish with make doc, and give the cache's Caddy block Access-Control-Allow-Origin https://tests.cardano.intersectmbo.org, as the cache README shows.

The public testing dashboard is a static page that shows how much
testing runs: runs, tests, test time, CLI invocations, releases
tested, sync runs and the issues our testing found upstream. Its data
is built and published by the testing-results-cache service; the
page itself needs only static hosting, so it lives here and the docs
site serves it at /dashboard/.

The page reads its data URL from a meta tag in index.html, so the
address of the cache is set in one place. The value committed here is
a placeholder; set it to the cache's public dashboard host before the
next docs deploy, or the published page shows no data. The folder is
listed in html_extra_path and copied into the site root as is, next
to CNAME.

This branch has not been deployed

No deployments
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.

1 participant