add user-stories #24
Open
add user-stories #24
Conversation
This file contains 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
Reviewer's Guide by SourceryThis PR adds documentation for user stories that describe different scenarios for accessing cloud services and data through LifeScience AAI. The changes include adding a new markdown file with detailed user stories and updating the navigation configuration to include the new document. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @svedziok - I've reviewed your changes - here's some feedback:
Overall Comments:
- There's a mismatch between the filename in mkdocs.yml ('guides/user-stories.md') and the actual file ('guides/user_stories.md'). Please update one to match the other.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 2 issues found
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
docs/guides/user_stories.md
Outdated
| @@ -0,0 +1,30 @@ | |||
| # User Stories | |||
|
|
|||
| With the elixir cloud activities, we support the development of cloud services to provide access to data and compute for researchers. Thereby we have various user stories in mind, which are listed below to guide researcher as well as service/data provider. | |||
There was a problem hiding this comment.
issue (documentation): Fix plural forms in the introduction
Change 'guide researcher as well as service/data provider' to 'guide researchers as well as service/data providers'
docs/guides/user_stories.md
Outdated
|
|
||
| **As a data controller, I can give a researcher access to a specific dataset, so that the researcher can work with the data in accordance with my data usage policies.** The data controllers are responsible for providing access to sensitive data. Regarding sensitive human data, patients have usually specified the purposes for which personal data may be accessed and the controllers must check whether these purposes are fulfilled in the event of a request. For this purpose, GA4GH defines the [Data Use Ontology](https://www.ga4gh.org/product/data-use-ontology-duo/) to standardize both consents and requests. Approved access requests can be stored uniformly via the [GA4GH Passport](https://www.ga4gh.org/product/ga4gh-passports/) specification. Life Science Login acts as a passport broker and can provide user authorizations for the cloud services ([GA4GH passport support in LifeScience AAI](https://docs.google.com/document/d/1QpMgSeDdtPJWujdR9Z93WsTC5I9vyvd4bHjpWcGVnz0/edit?tab=t.0#heading=h.vdrx3flw0u2j)). | ||
|
|
||
| # Analysis |
There was a problem hiding this comment.
issue (documentation): Inconsistent heading level
This heading uses a single # while other main sections use ##. Consider making it consistent with other sections.
file naming typo
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.
Added user stories with links to guides for guiding users.
Summary by Sourcery
Documentation: