Repository navigation
docs: fill the gaps in the researcher pages - #155
Conversation
Say how researchers use TES (proTES with an LS Login token from Krini, as members of ECP_CLN:EOC-Compute), point the Snakemake demonstrator at the deployment's proTES and drop the CWL demo pointer, remove the SPE page, which names no service of the deployment, and say that the Crypt4GH middleware is being ported. Closes #89 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Reviewer's GuideConfigurationRemove the obsolete SPE page from the site navigation.
DocumentationDocument the deployment’s TES access path, group membership requirement, and token-safety guidance for researchers.
Update the Snakemake demonstrator and CLI guidance, and remove the retired CWL demonstrator pointer.
Explain that Crypt4GH currently requires an unreleased proTES branch, record the tested versions, and document how to deploy that branch.
Remove the unsupported SPE researcher page and stop directing sensitive-data readers to it.
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Documentation build overview
21 files changed ·
|
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/researchers/index.md" line_range="41-44" />
<code_context>
+token from [Krini](krini.md#copy-your-access-token): proTES accepts tokens
+that LS Login issued to Krini.
+
+You can also send tasks directly to the TES services of the Nodes that
+require LS Login tokens. Find them, and their addresses, in the Cloud
+Registry (see [Using the
+APIs](../partners-and-developers/apis.md#1-find-the-services)).
+
+[gi-49]: <https://github.com/elixir-cloud-aai/generic-issues/issues/49>
</code_context>
<issue_to_address>
**Service tokens reach untrusted endpoints**
When a researcher follows the new instructions and chooses an untrusted or unverified TES endpoint, the guidance sends an LS Login bearer token or other service credentials to the selected TES endpoint without telling researchers to check whether they trust it. An untrusted endpoint operator can capture and replay those credentials, acting as the researcher until the token expires.
Warn researchers to verify and trust each TES endpoint before sending it bearer tokens or other credentials, and link to the Cloud Registry guidance on checking service labels.
Also at `docs/researchers/federated-workflows.md:52-53`.
</issue_to_address>
### Comment 2
<location path="docs/researchers/index.md" line_range="34-35" />
<code_context>
+## Which TES services you can use
+
+Send your tasks to the TES gateway of the deployment,
+[proTES](../operators/services/protes.md), at
+<https://protes.rahtiapp.fi/> (TES API at
+`https://protes.rahtiapp.fi/ga4gh/tes/v1`), with an LS Login access token.
+proTES forwards each task to one of the TES services of the Nodes. Get the
</code_context>
<issue_to_address>
**Readers get conflicting endpoint guidance**
When readers consult the linked proTES or API documentation alongside the researcher guidance, the researcher page publishes the deployment gateway address and TES endpoint, while the operator page says the address is not documented and the API guide says TES endpoints are not documented. Readers cannot tell which endpoint guidance is current.
Update the linked operator and API documentation to document the published gateway address and TES endpoint.
Also at `docs/researchers/federated-workflows.md:48`, `docs/researchers/index.md:36-37`.
</issue_to_address>
### Comment 3
<location path="docs/researchers/index.md" line_range="26-27" />
<code_context>
- APIs](../partners-and-developers/apis.md#1-find-the-services) shows how
- to list them in the Cloud Registry.
+2. Become a member of the LS Login group `ECP_CLN:EOC-Compute`, which
+ gives access to the compute services of the deployment. An application
+ form is coming ([generic-issues#49][gi-49]); until then, write to
+ [cloud-service@elixir-europe.org][elixir-on-cloud-email].
3. Choose a page above and follow its steps.
</code_context>
<issue_to_address>
**Admin members face unnecessary access steps**
When a researcher belongs to `ECP_CLN:ADMIN` but not `ECP_CLN:EOC-Compute`, the access instructions tell the researcher to join `ECP_CLN:EOC-Compute` and contact the service email, despite the TES guidance saying `ECP_CLN:ADMIN` members may run tasks. They are sent through an unnecessary access process.
State that `ECP_CLN:ADMIN` members may use the services without joining `ECP_CLN:EOC-Compute` or contacting the service email.
</issue_to_address>
### Comment 4
<location path="docs/researchers/index.md" line_range="19" />
<code_context>
-| [Crypt4GH with proTES](crypt4gh-with-protes.md) | Process Crypt4GH-encrypted files in a secure container. Needs proTES 0.3.0 or earlier. | Docker and three virtual machines. |
</code_context>
<issue_to_address>
**SPE guide recommendation leads nowhere**
The sensitive-data guide still directs readers to the Researchers index to try an SPE, but the removed entry leaves no SPE walkthrough or deployment service there; readers cannot follow the promised path to try one.
Revise the sensitive-data guide to clarify that the deployment currently offers no SPE to try, or point to a still-available SPE walkthrough.
</issue_to_address>Sourcery assessment
Approval pending. 4 findings to address first.
Blocking findings: docs/researchers/index.md:44, docs/researchers/index.md:35, docs/researchers/index.md:27, docs/researchers/index.md:19
Warn researchers to send their token only to verified services that they trust, and stop pointing the sensitive-data page to an SPE in the researcher section, which no longer has one. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Linked issuesChecked at commit 578f558 #61 docs: relaunch the hub at docs.elixir-on.cloud · 0 of 1 met
#89 docs: fill the gaps in the researcher pages · 3 of 4 met
|
No released proTES runs the middleware: 0.4.0 and later drop middlewares, and 0.3.0 refuses the released middleware, which doesn't derive from AbstractMiddleware. Document the unreleased proTES branch adjust_middleware that the tutorial's authors used, how to deploy it, and the versions they used, as far as they were recorded. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Summary
Fills the gaps that #89 lists in the researcher pages, with the maintainers' answers of 2026-11-17:
ECP_CLN:EOC-Compute(application form coming: generic-issues#49; until then, the service email). New section "Which TES services you can use": tasks go through the deployment's proTES (https://protes.rahtiapp.fi/) with an LS Login token from Krini; direct access only to TES services of Nodes that require tokens, found in the Cloud Registry.tes.data.crypt4gh(foca-plugins#65/docs: rewrite the researchers section #66 merged; 0.1.0 prepared, not published) and keeps using proTES 0.3.0 until then. The "Under construction" note is folded into that note.Removing
researchers/spe-with-weskit.mddrops its URL; the site has no redirect plugin.Closes #89
Closes #61
This PR closes the parent #61 too, as #81, #82 and #89 are its last open children: merge it after #153 and #154.
Verification
python scripts/check_names.py: passesmkdocs build --strict: passes, no warningspytest: 25 passed, 100% coverage (unchanged)Declined review findings
ECP_CLN:ADMINfor researchers. That group is for the admins of the deployment, not a path for researchers.Review
Light lane: docs only. I reviewed the diff myself.
🤖 Generated with Claude Code
Summary by Sourcery
Update researcher documentation to match the deployment’s available services, access requirements, and current demonstrators.
New Features:
Bug Fixes:
Enhancements:
Documentation:
Chores: