update sandbox docu#43
Open
vschnei wants to merge 1 commit into
Open
Conversation
Signed-off-by: Valentin Schneider-Lunitz <valentin.schneider-lunitz@charite.de>
Contributor
Reviewer's GuideUpdates 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
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
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>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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) |
Contributor
There was a problem hiding this comment.
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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: