Repository navigation
docs: fill the gaps in the partner pages - #154
Conversation
Point to the Cloud Registry as the source of truth for services, endpoints and API versions, list the services that use LS Login and how partners get their client ID accepted, and say that there is no test environment. Mark proWES and DRS-Filer as being revived, update TESK to TES 1.1.0 and drop CWL-WES and the retired CWL demo. Closes #82 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Reviewer's GuideDocumentationEstablish the Cloud Registry as the source of truth for deployed services, endpoints, and reported API versions, while qualifying that manual and out-of-sync entries may be stale.
Document the lack of a separate partner test environment and the services that accept LS Login tokens, including how partners request client-ID acceptance.
Update the product reference table and notes for TESK, proWES, and DRS-Filer to reflect their stated API versions and revival status.
Remove references to archived CWL-WES and the retired CWL demo from the partner pages and their shared reference links.
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Documentation build overview
15 files changed ·
|
Linked issuesChecked at commit 2b7ff10 #82 docs: fill the gaps in the partner pages · 3 of 5 met
|
There was a problem hiding this comment.
Hey - I've found 6 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="docs/partners-and-developers/packages.md" line_range="43-45" />
<code_context>
- maintained; their READMEs are kept for reference.
+- [proWES](https://github.com/elixir-cloud-aai/proWES): a WES gateway, and
+ [DRS-Filer](https://github.com/elixir-cloud-aai/drs-filer): a DRS service.
+ Both are being revived since 2026-11-16, after they had been archived;
+ they get docs sites with the revival, and until then their READMEs are
+ the docs.
More services are listed in the [GitHub organization][elixir-on-cloud-github].
</code_context>
<issue_to_address>
**Conflicting revival guidance**
When operators follow the partner pages to the operator service pages, catalog, or onboarding guidance, the operator documentation still labels proWES and DRS-Filer archived and unmaintained and says not to deploy them, contradicting the partner pages' revival guidance and leaving operators unsure whether the services are available.
Update the operator service pages, index, and onboarding guidance to match the revival status in the partner pages.
Also at `docs/partners-and-developers/apis.md:118-119`, `docs/partners-and-developers/ga4gh-standards.md:49-51`.
</issue_to_address>
### Comment 2
<location path="docs/partners-and-developers/apis.md" line_range="14-17" />
<code_context>
-The [Cloud Registry](https://cloud-registry.readthedocs.io/en/latest/) lists
-the services of the deployment. It implements the [GA4GH Service Registry
+The [Cloud Registry](https://cloud-registry.readthedocs.io/en/latest/) of
+the deployment is the source of truth for its services: which services
+run, their endpoints, and the versions of the GA4GH APIs that they
+implement, which the registry reads from the service info of each service
+(`GET /service-info`). These docs don't repeat them. The registry
+implements the [GA4GH Service Registry
API](https://github.com/ga4gh-discovery/ga4gh-service-registry). Anyone can
</code_context>
<issue_to_address>
**Registry details appear current**
When a registry entry is manual, out of sync, or belongs to Funnel or Poiesis, the registry retains manually entered or last-synced endpoints and API versions rather than reading current values from each service's `/service-info`, so partners can mistake stale details for current ones.
Qualify the guidance to explain that manually entered or out-of-sync registry entries may not reflect current service information.
Also at `docs/partners-and-developers/ga4gh-standards.md:15-16`.
</issue_to_address>
### Comment 3
<location path="docs/partners-and-developers/apis.md" line_range="8-9" />
<code_context>
- partner gets its client ID accepted, and a test environment. Until then,
- find the services in the Cloud Registry (step 1) or write to
- [cloud-service@elixir-europe.org][elixir-on-cloud-email].
+There is no separate test environment for partners: use the production
+services with a test account.
## 1. Find the services
</code_context>
<issue_to_address>
**Partners can select nonproduction endpoints**
When the registry contains a service entry whose environment is `test`, when the registry lists a service with environment `test`, the discovery instructions tell partners to choose by API type and call its URL but do not say to select only `prod`. A partner can therefore call a test Node despite being told to use production services.
Tell partners to use only entries marked `prod` and distinguish those from test-Node entries.
</issue_to_address>
### Comment 4
<location path="docs/partners-and-developers/ga4gh-standards.md" line_range="24" />
<code_context>
+| [TESK][tesk] | [TES][ga4gh-tes], for tasks | [1.1.0](https://github.com/elixir-cloud-aai/tesk-api/releases/tag/v2.0.0) (tesk-api 2.0.0) | [1.1.0](https://github.com/ga4gh/task-execution-schemas/releases/tag/v1.1) | [TESK](https://tesk.readthedocs.io/en/latest/) |
</code_context>
<issue_to_address>
**TESK version link skips the specification**
When a partner follows the TESK implemented-version link to verify the specification, the TESK row links its implemented `1.1.0` version to the `tesk-api` release page, not to the API specification or its source commit as the page promises. Partners following the version link cannot inspect the specification that the product builds on.
Link the implemented version to the TES specification file or commit, and keep the `tesk-api` release link as supporting implementation evidence.
</issue_to_address>
### Comment 5
<location path="docs/partners-and-developers/packages.md" line_range="41-44" />
<code_context>
federates TES services.
- [TRS-Filer](https://trs-filer.readthedocs.io/en/latest/): a TRS service for
tools and workflows.
-- [proWES](https://github.com/elixir-cloud-aai/proWES): a WES gateway,
- [CWL-WES](https://github.com/elixir-cloud-aai/cwl-WES): a WES service for CWL
- workflows, and [DRS-Filer](https://github.com/elixir-cloud-aai/drs-filer): a
- DRS service. These three were archived on 2026-11-15 and are no longer
- maintained; their READMEs are kept for reference.
+- [proWES](https://github.com/elixir-cloud-aai/proWES): a WES gateway, and
</code_context>
<issue_to_address>
**CWL-WES docs status**
The issue asks whether CWL-WES will get a docs site. The change removes CWL-WES from the package list but gives no answer about its docs.
</issue_to_address>
### Comment 6
<location path="docs/partners-and-developers/ga4gh-standards.md" line_range="26" />
<code_context>
-| [CWL-WES](https://github.com/elixir-cloud-aai/cwl-WES) | [WES][ga4gh-wes], for workflows | [1.0.0](https://github.com/elixir-cloud-aai/cwl-WES/blob/dev/cwl_wes/api/20181010.be85140.workflow_execution_service.swagger.yaml) | [1.1.0](https://github.com/ga4gh/workflow-execution-service-schemas/releases/tag/1.1.0) | archived, unmaintained: see the README |
</code_context>
<issue_to_address>
**CWL-WES catch-up status**
The issue asks about plans to catch up with current specifications, including CWL-WES. The change removes its specification-table row without documenting its status or plans.
</issue_to_address>Sourcery assessment
Approval pending. 5 findings to address first.
Blocking findings: docs/partners-and-developers/packages.md:45, docs/partners-and-developers/apis.md:17, docs/partners-and-developers/apis.md:9, docs/partners-and-developers/packages.md:44, docs/partners-and-developers/ga4gh-standards.md:26
Say that manual and out-of-sync entries of the Cloud Registry may be out of date, and don't call the services of the deployment "production", as some of them report the environment "test". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Summary
Fills the gaps that #82 lists in the partner pages, with the maintainers' answers of 2026-11-17:
1.1.0in its service info); proWES and DRS-Filer catch up with the revival; the product table stays as a reference of what each product implements, with the registry as the source of truth for running services.Also removes the pointer to the retired CWL demo of 2023 from "Run workflows through TES" and its unused link reference (docs#89 item 2 drops the CWL demonstrator; this file belongs to this PR, so the line goes here and #89's PR doesn't touch it).
Closes #82
Verification
python scripts/check_names.py: passesmkdocs build --strict: passes, no warningspytest: 25 passed, 100% coverage (unchanged)Declined review findings
prodentries only. Some services of the deployment (e.g., its proTES) reporttest; the page instead no longer says "production".Review
Light lane: docs only. I reviewed the diff myself.
🤖 Generated with Claude Code
Summary by Sourcery
Bring partner and developer documentation up to date with current service discovery, authentication, API-version, and product availability information.
New Features:
Enhancements:
Documentation: