-
Notifications
You must be signed in to change notification settings - Fork 2
Processing sensitive data #30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Reviewer's GuideThis PR adds a new section on processing sensitive data to the ELIXIR-on-Cloud documentation by updating the site navigation, creating a guides index page, and introducing a detailed guide covering legal frameworks, secure environments, and use cases. Class diagram for secure environments in sensitive data processingclassDiagram
class Environment {
+Isolation
+Security
+Integrity
+Confidentiality
+Controlled Access and Authentication
+Collaboration and Analysis
}
class TEE {
+Secures startup, code, and data during execution
+Used in secure mobile/cloud environments
}
class SPE {
+Ensures secure data processing and computation
+Applied in secure analytics/cryptographic computation
}
class TRE {
+Comprehensive secure research environment
+Emphasizes privacy, governance, compliance
}
Environment <|-- TEE
Environment <|-- SPE
Environment <|-- TRE
Flow diagram for sensitive data processing use casesflowchart TD
A[Researcher needs to process sensitive data]
B{Where is the data stored?}
C[Central data]
D[Federated data]
E{Where is the data processed?}
F[Local processing]
G[Cloud processing]
H[Data repository]
I[Cloud platform]
J[Federated database]
K[Federated processing]
A --> B
B --> C
B --> D
C --> E
D --> E
E --> F
E --> G
C --> E
D --> E
C --> F --> H
C --> G --> I
D --> F --> J
D --> G --> K
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a new documentation guide for handling sensitive human data within the ELIXIR-on-Cloud framework and exposes it in the site navigation.
- Update mkdocs.yml to add a Guides index and link to the Sensitive Data page
- Create
docs/guides/index.md
as the main entry point for ELIXIR-on-Cloud documentation - Add
docs/guides/guide-info/sensitive_data.md
covering legal frameworks, secure environments, and use cases
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
File | Description |
---|---|
mkdocs.yml | Inserted new nav entries for the guides index and Sensitive Data page |
docs/guides/index.md | Added top-level documentation landing page |
docs/guides/guide-info/sensitive_data.md | Added detailed guide on processing sensitive human data |
Comments suppressed due to low confidence (1)
mkdocs.yml:85
- [nitpick] The navigation entry for the guides index uses only the file path. Consider adding a user-friendly title (e.g.,
Guides Overview: guides/index.md
) so the link displays clearly in the site menu.
- "guides/index.md"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @svedziok - looks good.
Perhaps three minor suggestions:
- Perhaps better to name the new section "General" rather than "Information", given that all the other guides also contain "information"?
- Throughout the organization, we are using semantic commit messages of 50 chars or less as PR titles. The precise guidelines are here: https://elixir-cloud-aai.github.io/guides/guide-contributor/general-guidelines/#commit-messages Together with squash merging commits from a feature branch, this keeps our commit histories clean, consistent and amenable to release automation when we squash merge commits. See example titles here (admittedly, it's a little boring for a docs page): https://github.com/elixir-cloud-aai/elixir-cloud-aai.github.io/pulls?q=is%3Apr+is%3Aclosed
- Note that throughout the repo, only named references are used, and that all of the named references are listed in file
includes/references.md
. This makes it easier to read the raw files and makes the reuse and maintenance of references easier. Btw, there is alsoincludes/abbreviations.md
, where one can define abbreviations centrally. Every time an abbreviation listed in the file is used, there will be a tool tip created in the docs that resolves the abbreviation. Very useful!
add section for working with sensitive data in the ELIXIR-on-Cloud framework
Summary by Sourcery
Add a new ELIXIR-on-Cloud documentation guide on processing sensitive human data, covering legal frameworks, secure environment definitions, and use cases, and expose it in the site navigation.
Build:
Documentation: