Skip to content

update sandbox docu#43

Open
vschnei wants to merge 1 commit into
mainfrom
update_sandbox_docu
Open

update sandbox docu#43
vschnei wants to merge 1 commit into
mainfrom
update_sandbox_docu

Conversation

@vschnei

@vschnei vschnei commented Jun 30, 2026

Copy link
Copy Markdown

This MR includes updated Sanbox documentation for the following topics:
Funnel, TES-K, Poiesis, and Authentication.
References to service deployments are set.

Summary by Sourcery

Document additional sandbox components and authentication mechanisms.

Documentation:

  • Add high-level documentation for Funnel, TESK, and Poiesis sandbox services.
  • Describe authentication in the sandbox using Life Science Login (LS AAI) and reference deployment examples.
  • Link sandbox documentation to corresponding service deployment and repository resources.

Signed-off-by: Valentin Schneider-Lunitz <valentin.schneider-lunitz@charite.de>
@sourcery-ai

sourcery-ai Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Updates the sandbox documentation to describe Funnel, TESK, Poiesis, and LS Login-based authentication, and adds cross-references to related deployment/service documentation.

File-Level Changes

Change Details Files
Document Funnel as a TES reference implementation and link to its deployment guide.
  • Added a Funnel section explaining its purpose as a GA4GH TES reference implementation across heterogeneous infrastructures.
  • Clarified use cases in multi-omics computing and how Funnel abstracts underlying infrastructure behind the TES API.
  • Linked to the Funnel deployment documentation for detailed service deployment instructions.
docs/sandbox/index.md
Add high-level descriptions of TESK and Poiesis as Kubernetes-native TES implementations and reference further resources.
  • Added a TESK section describing it as a Kubernetes-native GA4GH TES implementation within the ELIXIR Cloud & AAI ecosystem.
  • Added a Poiesis section describing its TES v1.1.0-compliant, stateless, Kubernetes-focused architecture.
  • Linked to the Poiesis GitHub repository for detailed deployment and usage instructions.
docs/sandbox/index.md
Introduce LS Login (LS AAI) authentication overview and reference service integration examples.
  • Added an Authentication with LS Login section explaining LS Login/LS AAI and its role as a federated identity and access management platform.
  • Described LS Login’s evolution from ELIXIR AAI and adoption as the primary authentication platform.
  • Linked to examples of LS Login service integrations for deployment references while keeping the existing 'Under construction' notice.
docs/sandbox/index.md

Possibly linked issues

  • #(not specified): PR updates Sandbox topics (Funnel, TES-K, Poiesis, Authentication), directly addressing the issue’s Sandbox documentation update task.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@vschnei vschnei requested a review from svedziok June 30, 2026 09:59
@vschnei vschnei self-assigned this Jun 30, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 1 issue, and left some high level feedback:

  • There are a few minor typos and grammar issues in the new sections (e.g., “Sanbox” in the description, missing periods at the end of some sentences, and phrasing like “deployment examples can be found” being slightly redundant) that would benefit from a quick language pass for clarity and consistency.
  • Ensure consistent naming and linking conventions across the new content (e.g., “TESK” vs. “TES-K” in the PR description, and removing the extra space in the Funnel deployment link [Funnel deployment]( ../services/funnel.md)), so references and formatting remain uniform throughout the docs.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- There are a few minor typos and grammar issues in the new sections (e.g., “Sanbox” in the description, missing periods at the end of some sentences, and phrasing like “deployment examples can be found” being slightly redundant) that would benefit from a quick language pass for clarity and consistency.
- Ensure consistent naming and linking conventions across the new content (e.g., “TESK” vs. “TES-K” in the PR description, and removing the extra space in the Funnel deployment link `[Funnel deployment]( ../services/funnel.md)`), so references and formatting remain uniform throughout the docs.

## Individual Comments

### Comment 1
<location path="docs/sandbox/index.md" line_range="40-42" />
<code_context>
+
+LS Login evolved from the original ELIXIR AAI and became the primary authentication platform in 2022 after integration with multiple European life-science infrastructures
+
+Various examples of LS Login deployment examples can be found [here](../services/services_to_ls_aai.md)
+
 !!! warning "Under construction"
</code_context>
<issue_to_address>
**suggestion (typo):** Remove repeated word and add a period in the LS Login examples sentence.

Consider rephrasing to avoid the repeated “examples”, for instance: “Various LS Login deployment examples can be found …”.

```suggestion
LS Login evolved from the original ELIXIR AAI and became the primary authentication platform in 2022 after integration with multiple European life-science infrastructures.

Various LS Login deployments can be found [here](../services/services_to_ls_aai.md).
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread docs/sandbox/index.md
Comment on lines +40 to +42
LS Login evolved from the original ELIXIR AAI and became the primary authentication platform in 2022 after integration with multiple European life-science infrastructures

Various examples of LS Login deployment examples can be found [here](../services/services_to_ls_aai.md)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (typo): Remove repeated word and add a period in the LS Login examples sentence.

Consider rephrasing to avoid the repeated “examples”, for instance: “Various LS Login deployment examples can be found …”.

Suggested change
LS Login evolved from the original ELIXIR AAI and became the primary authentication platform in 2022 after integration with multiple European life-science infrastructures
Various examples of LS Login deployment examples can be found [here](../services/services_to_ls_aai.md)
LS Login evolved from the original ELIXIR AAI and became the primary authentication platform in 2022 after integration with multiple European life-science infrastructures.
Various LS Login deployments can be found [here](../services/services_to_ls_aai.md).

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