Repository navigation
docs: verify and fix operational facts - #172
Conversation
Check the facts of the pages listed in #171 against the live services, the Cloud Registry, GitHub and the product docs, and fix what is wrong: - Poiesis CZ returns an error page "503 Service not available"; link its filer protocols instead of the usage page, which doesn't list them. - proTES: its only TES service is the TESK for tests at CSC, which accepts tasks without a token; its environment is `test`. - TRS-Filer: the deployment runs 0.5.1.dev13 with TRS 2.0.2; write tokens (trs-filer#7) and the service info value (trs-filer#135) are on its default branch, not just planned. - Onboarding: Funnel also runs with OpenPBS. - proTES and TRS-Filer aren't in the registry yet; registry artifacts are lower case (`tes`). - Node tutorial: the ECP_CLN values are recorded (generic-issues#46) and the central Pubgrade runs (generic-issues#32). - GA4GH SDK: login, task log downloads and release builds of binaries and images are on its default branch after the commit that the CLI page describes. - Demos: the Crypt4GH middleware repository is archived. Set `last_verified: 2026-11-17` on the pages whose facts were all checked today: the operators' start page, Onboarding, the services index, Poiesis, proWES and DRS-Filer. The other pages stay `null`: some of their facts can't be checked without credentials or a test run. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Reviewer's GuideDocumentationCorrect the documented proTES backend and deployment environment, then update the researcher-facing description to match.
Update TRS-Filer deployment facts and align the onboarding tutorial with the chart’s upcoming service-info value and write-token support.
Correct the node-onboarding guidance for LS Login group claims and the Pubgrade rollout.
Correct onboarding platform guidance and clarify that the OpenPBS Funnel steps remain untested.
Correct Poiesis status and link to the product documentation that lists supported filer protocols.
Clarify which services are absent from the Cloud Registry and correct the API artifact’s casing.
Update the CLI documentation for SDK features and release-workflow outputs available after the documented commit.
Qualify demo status with current SDK capabilities, the hybrid-cloud demo’s failed CI run, and the archived Crypt4GH repository.
Record the verification date for the operators’ start page.
Record the verification date for the DRS-Filer page.
Record the verification date for the services index.
Record the verification date for the onboarding page.
Record the verification date for the proWES page.
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Documentation build overview
14 files changed ·
|
Linked issuesChecked at commit 0848da7 #171 Docs pages to verify · 0 of 1 met
|
There was a problem hiding this comment.
Hey - I've found 4 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="docs/operators/services/protes.md" line_range="48" />
<code_context>
A Node's TES service is added to the configuration when its admins ask for
it and the service requires LS Login tokens (see [Get added behind the
gateway](../node-onboarding-tutorial.md#7-get-added-behind-the-gateway)).
+No Node's TES service has been added yet.
The service info of proTES (`GET /ga4gh/tes/v1/service-info`) lists the TES
services that it uses. The rest of its configuration, such as its plugins
</code_context>
<issue_to_address>
**Gateway tasks miss Node services**
When users follow the deployment-specific guidance while proTES still has only the CSC test TESK configured, `researchers/index.md` says proTES forwards tasks to Node services, but the deployment now has only the CSC test TESK configured. Users following that guidance send tasks to the test service, not a Node.
Update the researchers' guidance to distinguish the current CSC test backend from Node services that may be added later.
</issue_to_address>
### Comment 2
<location path="docs/operators/onboarding.md" line_range="40" />
<code_context>
| Kubernetes or OpenShift | [TESK](services/tesk.md) |
| Kubernetes | [Poiesis](services/poiesis.md) |
-| HPC or HTC (Slurm) | [Funnel](services/funnel.md) |
+| HPC or HTC (Slurm, OpenPBS) | [Funnel](services/funnel.md) |
Follow the product docs that each page links to. When it works,
</code_context>
<issue_to_address>
**OpenPBS onboarding overstates support**
When a Node operator chooses OpenPBS from the onboarding table, the onboarding table presents OpenPBS as an ordinary Funnel option, but the Funnel page says its OpenPBS steps have not been tested and warns that failed jobs can retain their last state. The overview therefore presents an unverified path without its operational caveat.
Label OpenPBS as documented but untested in the onboarding table and point readers to the Funnel page's warning.
</issue_to_address>
### Comment 3
<location path="docs/demos/index.md" line_range="31" />
<code_context>
| [Hybrid cloud via TES][repo-hybrid] (`demo-tes-hybrid-cloud`) | Current | A Snakemake workflow on the TES services of several Nodes, one after the other, and then on all of them through proTES. Runs on your computer with two local Funnel instances, proTES 0.6.0 and an S3 service, or on your own services. | [Run Workflows Across Nodes](../researchers/federated-workflows.md) |
</code_context>
<issue_to_address>
**Demo appears confirmed working**
When the latest CI run has failed and no successful rerun has confirmed the demo works, the hybrid-cloud row stays marked Current, which the page defines as working as described, so readers are told the demo works without confirmation.
Qualify the status or update it after a successful rerun.
</issue_to_address>
### Comment 4
<location path="docs/researchers/cli.md" line_range="587-588" />
<code_context>
+| Ready-made binaries, without Rust | Built by the release workflow on the default branch ([ga4gh-sdk#91](https://github.com/ga4gh/ga4gh-sdk/issues/91)); none published yet, as the SDK has no release yet. |
</code_context>
<issue_to_address>
**Release workflow trigger unclear**
The issue description says the release workflow builds binaries and images on `v*` tags, but these rows say they are built by a workflow “on the default branch.” Clarify that the workflow is present on the default branch and produces artifacts for release tags.
</issue_to_address>Sourcery assessment
Approval pending. 3 findings to address first.
Blocking findings: docs/operators/services/protes.md:48, docs/operators/onboarding.md:40, docs/demos/index.md:31
- Researchers: proTES forwards tasks only to the CSC test TESK for now. - Onboarding: point to the caveat of the untested OpenPBS steps. - Demos: say that the hybrid cloud demo's latest CI run failed on a third-party file. - CLI: binaries and the image are built for version tags. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Summary
Verifies the operational facts of the 25 pages listed in #171 against public, read-only sources (service info and other unauthenticated
GETs of the live services, the Cloud Registry API, GitHub issues, releases and repository contents viagh, and the product docs), fixes the facts that were wrong, and setslast_verified: 2026-11-17only on the 6 pages whose facts were all checked today. No credentials were used.Fixes
GET https://poiesis.dyn.cloud.e-infra.cz/ga4gh/tes/v1/service-info(and every other path) returns an HTML page "503 Service not available" (with HTTP 200). The page said "runs"; it now says it doesn't answer, and isn't behind the gateway or in the registry. The claim "S3 and HTTP(S), not FTP" now links to the docs section that lists the filer protocols (s3://,http(s)://,file://, inline content); the old link (Usage) doesn't list them.https://csc-tesk-noauth.rahtiapp.fi(source: configured), whoseGET /ga4gh/tes/v1/tasksanswers200without a token. The page said "the TESK of the Finnish Node"; it now names the TESK for tests at CSC, says it accepts tasks without a token, that no Node's TES service has been added yet, and that the environment istest("proTES sandbox (BioHackathon 2026)").0.5.1.dev13+gfa501e6dcand TRS2.0.2; v0.5.0 reports TRS2.0.1(itsconfig.yamlat the tag) and has no authentication. The data-centre tutorial is pinned to 0.5.0, so it was right about 0.5.0; the TRS-Filer page now gives the version of the deployment and the difference. trs-filer#7 (tokens for writes) and docs: send access tokens in the TES tutorials #135 (service info as a chart value, checked indeployment/values.yamlondev) are closed as completed, so the tutorial no longer calls them merely planned: they are on the default branch and come with the next release.GC6ZQGBIH Funnel,J0LBQGthe registry,N27TBGJAN DIGITRUST TESK lab,EW7DI3BIH WESkit). The services index and the API guide said to find their addresses there; both now say they aren't registered yet and point to their pages. (No registry-pointer work of docs: point service pages to the registry #157.) The API guide now writes the artifact as the registry does (tes, notTES).af0e021, 2026-11-12), the GA4GH SDK gotloginwith the OpenID Connect device flow (ga4gh-sdk#248, merged 2026-11-15; LS Login's discovery document has adevice_authorization_endpoint) and the download of task logs and outputs (#188); docs: update Cloud Registry page to 1.0.0rc1 #91 (binaries) and #189 (image) are closed, and are built byrelease.ymlonv*tags, of which there are none yet. "What's coming" and the demos row say so, instead of "Planned" and "can't log in itself yet".protes-middleware-crypt4ghis archived; the row says so.Verified and dated (2026-11-17):
operators/index.md,operators/onboarding.md,operators/services/index.md,operators/services/poiesis.md,operators/services/prowes.md,operators/services/drsfiler.md.Pages left at
null, and whydemos/index.mddemo-tes-hybrid-cloudonmain(run 43381845527, 2026-11-13) failed: a workflow input,https://www.mzv.cz/…/661666_637430_mzv_en.png, answered 404. It answers 200 again today, so the failure looks transient, but a re-run is needed before the "Current" state can be confirmed (my re-run was denied). The other repos' default branches have green CI.researchers/federated-workflows.mdoperators/services/protes.mdECP_CLN:EOC-Compute, tokens issued to Krini's client) needs a token;GET /taskswithout one gives401and the served OpenAPI requires a bearer token for every task and plugin operation.researchers/index.mdoperators/services/trsfiler.mdpartners-and-developers/apis.md/me→401, Swagger UI, LS Login issuer and scopes are verified.operators/using-cloud-registry-ui.mdECP_CLN:ADMIN(needs a token). Front end, API base URL, LS Login as the only login provider (the UI redirects tologin.aai.lifescience-ri.euwith scopeopenid profile email eduperson_entitlement), limit of 20 services andcontrolledtypes are verified.operators/cloud-registry.md,operators/using-cloud-registry.mdenvironments,controlled, 20 per user, sync every 24 h,contactUrl, version 1.0.0rc2) match. Not checked in full. The registry's own entryJ0LBQGis an imported, synced entry (serviceInfoId: ELIXIR_CLOUD_SERVICE_REGISTRY_1), not the self-listing thatcloud-registry.mddescribes, whose ID would beELIXIR_CLOUD_SERVICE_REGISTRY_1.operators/node-onboarding-tutorial.md,operators/data-centre-onboarding-tutorial.mdoperators/service-info.mdid, organization andenvironment: prod, withversion: unknown, so it seems to run a modified build; the page's statement about released Funnel still holds.operators/ls-login.mdresearchers/cli.md,researchers/tutorial-cli.mdaf0e021. The example output ofregistry listshows 2 services, the registry lists 4 today; updating it needs a build of the CLI. Moving the pages to the current SDK (withlogin) is a rewrite and a new test run.researchers/krini.md,researchers/tutorial-krini.mdresearchers/crypt4gh-with-protes.mdfoca-plugin-tes-data-crypt4ghrelease yet, as the page says).tutorials/tes-services/interactive_services_tes.mdThe weekly
Linksrun opens a new "Docs pages to verify" issue for the remaining 19 pages once this one is closed.Light lane: only docs text and front matter change; no hooks, scripts or CI. I reviewed the diff myself.
How it was verified
python scripts/check_names.py: OK.mkdocs build --strict: built without warnings (registry table rendered from the live registry).pytest: 356 passed, 100% coverage.python scripts/check_verified.py: 19 pages due (was 25), exit 2 as expected.GETs on 2026-11-17: service info of proTES, TRS-Filer, Poiesis CZ, CSC TESK, BIH Funnel, BIH WESkit and the registry;GET /services,/services/types,/verifications,/syncsand/meof the registry; the served OpenAPI documents of proTES, TRS-Filer and the registry; the UI's login redirect; LS Login's discovery document;ghfor releases, tags, issue states, repo contents (trs-filerv0.5.0anddev, ga4gh-sdk workflows and docs, poiesis filers) and CI runs of the demo repos.Declined review findings
None (light lane, no reviewer subagents). Sourcery's four findings are fixed in 0848da7 and their threads resolved: the researchers' start page now says proTES forwards tasks only to the CSC test TESK for now; the onboarding table points to the caveat of the untested OpenPBS steps; the hybrid cloud row says its latest CI run failed on a third-party file; the CLI rows say the binaries and image are built for version tags.
Open questions
None.
Closes #171
🤖 Generated with Claude Code