Repository navigation
Conversation
signekb
requested changes
Oct 6, 2026
signekb
left a comment
Contributor
There was a problem hiding this comment.
Looks great! Some minor suggestions:
| The API keys required to download data and metadata from the various data | ||
| sources are stored as environment variables. If these are not available when the | ||
| pipeline runs, tasks that fetch data or metadata from the APIs will return an | ||
| error. For reference, the `.env.example` file lists the names of all environment |
Contributor
There was a problem hiding this comment.
Suggested change
| error. For reference, the `.env.example` file lists the names of all environment | |
| error. For reference, the [`.env.example`](https://github.com/onlimit-study/feasibility-data/blob/main/.env.example) file lists the names of all environment |
Might be nice to link to it?
Comment on lines
+355
to
+356
| own user space. If you want to override a value from the shared file for testing | ||
| or development purposes in your personal repository clone, you can add it as an |
Contributor
There was a problem hiding this comment.
Suggested change
| own user space. If you want to override a value from the shared file for testing | |
| or development purposes in your personal repository clone, you can add it as an | |
| own user space. If you want to use another value for testing | |
| or development purposes in your personal repository clone, you can add it as an |
Just so it doesn't sound like an actual overwrite of the value in the shared env file.
| or development purposes in your personal repository clone, you can add it as an | ||
| environment variable in a `.env` file in the project root. | ||
|
|
||
| When working locally, the shared environment variables file is not available. If |
Contributor
There was a problem hiding this comment.
Suggested change
| When working locally, the shared environment variables file is not available. If | |
| When working locally (i.e., outside GenomeDK), the shared environment variable file is not available. If |
|
|
||
| When working locally, the shared environment variables file is not available. If | ||
| you are developing against a test API or working with an API that only provides | ||
| metadata, you can add the relevant API keys to a `.env` file in the project |
Contributor
There was a problem hiding this comment.
Suggested change
| metadata, you can add the relevant API keys to a `.env` file in the project | |
| metadata, you can add the relevant API keys to a `.env` file in your project |
Comment on lines
+362
to
+364
| root. In general, to prevent accidentally downloading participant data locally, | ||
| API keys for live data sources containing real participant data should not be | ||
| used outside GenomeDK. |
Contributor
There was a problem hiding this comment.
Suggested change
| root. In general, to prevent accidentally downloading participant data locally, | |
| API keys for live data sources containing real participant data should not be | |
| used outside GenomeDK. | |
| root. | |
| ::: callout-important | |
| In general, to prevent accidentally downloading participant data locally, | |
| API keys for live data sources containing real participant data should not be | |
| used outside GenomeDK. | |
| ::: |
Not sure that this works as intended since this is an md file, but it is rendered on the website as well (where this seems to work fine). I would just like to emphasise this part bc it's quite important.
This branch has not been deployed
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
2 participants
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.
Description
This adds a section about API keys. Feel free to edit.
Closes #155
Needs a medium-depth review.
Checklist
just run-alljust build-package