Collection of onboarding materials for establishing a Federated EGA Node.
Home Page: https://ega-archive.github.io/FEGA-onboarding/
License: Creative Commons Attribution Share Alike 4.0 International
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
Content addition
https://ega-archive.github.io/FEGA-onboarding/#what-is-federated-ega-fega
In the new section created by Jorge about the value and benefits of joining FEGA, embed the YouTube video (link here so that someone can play it from the website. Optionally, add a link that opens a new browser tab to YouTube where the video will play.
it's a nice addition to this new section
Location
Root directory of this repo.
Change
Remove the index.md file in the root directory. Keep the file docs/index.md as this is the file that generates the landing page of the website. Before removing index.md, check that this won't break the website. Maybe GHpages/Jekyll expects is there? If so, consider keeping the file but deleting all the content.
Reason
It is confusing to have both index.md and docs/index.md (e.g. PR #19). The latter generates the landing page of the website. The former isn't used for anything.
Location
Change
Reason
These suggestions will help improve clarity of the materials for people who are not so familiar with Federated EGA already by providing a bit more context, rewording things that aren't clear, and reordering content so it flows better. Suggestions kindly provided by Carles Garcia :)
Location
All webpages which have links to external materials.
Change
Currently, links to external materials/sites are opened in the same tab that is currently being used. Thus, if someone wants to go back to the FEGA pages, they have to navigate back from where they are. A better UX would be that external links open in a new tab in the same window, so that a user can easily switch back to the FEGA pages without losing access to the external materials they just opened. Internal links to other pages in the FEGA website can probably stay in the same tab, since it doesn't navigate someone away from the FEGA website.
Reason
This change is requested to offer a better UX for someone navigating the materials linked to from the FEGA onboarding website.
Content addition
Not sure, but perhaps https://ega-archive.github.io/FEGA-onboarding/topics/governance-legal/#2-implement-legal-frameworks
Add a link to the official "FEGA Node Operations Guidelines" document (pdf?).
When we try to work out new routines at our local node, I often find myself looking for official documents to get some guidance. Sometimes I find a document on Google Drive, but it is often hard to know if it really is the latest official version or not. Therefore I think it would be very useful if all the official documents that concern the whole federation could be collected on the onboarding website.
Content addition
to add the link to the security breach protocol, when it is approved by Ops committee. We need to discuss with the committee whether to include full version or just a template version. Question of including all contacts and appendices, in general.
https://docs.google.com/document/d/1lp89PhWsKMCZy22wfgI4r9Ug5oKTXsYfK3jF12VN8uQ/edit#
needs to be added. Currently says "coming soon"
Location
https://github.com/EGA-archive/FEGA-onboarding/tree/main/.github/ISSUE_TEMPLATE
Change
Request to change the current issue templates (in markdown) for some in YAML (example: ega-metadata-schema bug report template).
Reason
Templates in YAML format allow for:
Content addition
https://ega-archive.github.io/FEGA-onboarding/topics/data-metadata-management/#metadata-standards
I would like to add links to 4 videos published on YouTube about metadata / COVID-19 HGI data dictionary made as part of ELIXIR CONVERGE WP7 which describe metadata that is relevant for FEGA. Video links are:
We want to be able to share more broadly these outputs from ELIXIR CONVERGE WP7 , Task 7.3, and help groups setting up FEGA nodes to understand the data model. Also linked to training WP2.
The external channels of the Outreach and Training page mentions two possibilities which can lead to a dilution of the message or even that users make mistakes.
Currently, the first option (hashtag #FederatedEGA) has +50 tweets, while the second (combination of hashtag and mention) has only 8 tweets.
Up to discussion to use only the first option, thus remove the second one from the page.
Content addition
add link to risk register template when it is ready
https://docs.google.com/spreadsheets/d/1CSAIKTrytLdvylPudFh7f0smrIMMAG6X7Ovf0__dszE/edit#gid=1384335863
currently says "coming soon"
Noticed broken links within the FEGA onboarding
Click on the broken links hyperlinks
Either 40X errors, or outdated information is displayed.
The correct content is reached
Related PR: #71
All hyperlinks of the FEGA onboarding site should be checked. So far, the list of links found to be broken is (see comment)
docs/topics/data-metadata-management/index.md:
https://ega-archive.org/beacon/#/ --> https://ega-archive.org/about/projects-and-funders/beacon/https://ega-archive.org/ga4gh --> https://ega-archive.org/about/projects-and-funders/ga4gh/https://ega-archive.org/beacon-api/ --> 🤷https://ega-archive.org/data-use-conditions --> https://ega-archive.org/access/data-access-committee/data-use-ontology/https://ega.ebi.ac.uk:8052/elixir/tickets/tickets --> 🤷https://web3.ega-archive.org/metadata/validation/metadata-schema/ --> https://ega-archive.org/submission/metadata/ega-schema/https://www.youtube.com/watch?v=josXa1CydxA --> 🤷https://www.ga4gh.org/docs/ga4ghtoolkit/data-security/Privacy-and-Security-Policy.pdf --> (likely) Data Privacy and Security Policy (v1.0): https://www.ga4gh.org/document/privacy-and-security-policy/https://www.ga4gh.org/docs/ga4ghtoolkit/data-security/2016May10_REV_SecInfrastructure.pdf --> (perhaps) DATA SECURITY INFRASTRUCTURE POLICY: https://github.com/ga4gh/data-security/blob/master/DSIP/DSIP_v4.0.md (not sure if this one is the same as 2016May10_REV_SecInfrastructure.pdf, but couldn't find this last)Content addition
https://ega-archive.github.io/FEGA-onboarding/topics/outreach-training/#3-follow-news-and-updates
Link to 1) the recorded video from the ELIXIR AHM 2023 FEGA Workshop (link TBD) and 2) the slides from the workshop, perhaps on the Outreach page (e.g. here) or the Tech and Ops page (e.g. here).
The workshop recording and presented slides will be beneficial to new nodes to see the current services available at FEGA with examples from CEGA, FEGA Norway, and FEGA Finland.
When you use the search bar to search for content it returns a 404 error and says there is no website there
e.g. https://ega-archive.github.io/search.html?q=governance
It takes you to a standard 'page not found' page from github with the following text:
404
There isn't a GitHub Pages site here.
If you're trying to publish one, [read the full documentation](https://help.github.com/pages/) to learn how to set up GitHub Pages for your repository, organization, or user account.
[GitHub Status](https://githubstatus.com/) — [@githubstatus](https://twitter.com/githubstatus)
Takes you to a page that shows you the pages that have the search term you are looking for or similar
It seems like something is going wrong in the configuration maybe because there is not /FEGA-onboarding/, in the URL when you try to search
Content modification, Content addition
Currently, the SOP section of the website contains the text: "It is useful to establish SOPs for common node operational tasks to enable consistent service delivery and streamline internal processes. Use this template to develop SOPs for your own node." The link points to a Google document stored in Google Drive.
As part of working on ELIXIR CONVERGE deliverable D7.4, we want to point to this template. However, it is better to avoid linking to Google documents which can often change and are not stable, and instead link to something more stable, for example materials hosted in this GH repository (i.e. the FEGA Knowledge Base). Therefore, the request is to 1) add the template document (in what format?) to this GH repository, and 2) update the link (on this page) to point to the document in GH so that it is more stable.
[The "Data and Medata Management" section contains a link to the data flow.
The presentation linked contains comments and it is a google slides document.
Consider making a more stable document with DOI.](https://docs.google.com/presentation/d/1IrU5jPJpGQ7n-WH-7WvJZjjH03ww9LfFMLK1kTBeAco/edit#slide=id.gcf2c0c3039_0_126)
Content addition
https://ega-archive.github.io/FEGA-onboarding/
on the main page somewhere we need to acknowledge EC and Elixir-Converge project. Here is the approved text:
“This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 871075”.
or
“This [infrastructure][equipment][insert type of result] is part of a project that has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 871075”.
What should we call this? Are we acknowledging the onboarding website or FEGA in general?
Could use: [website], [resource]
EU logo
At the Converge project review by EC it was noticed this was missing.
Location
https://ega-archive.github.io/FEGA-onboarding/topics/governance-legal/#fega-collaboration-agreement
Change
Add link to the Federated EGA Collaboration (Legal) Agreement when it is available publicly. Also include some context that describes that this is the current version, nodes are welcome to take a copy to start to review with their relevant legal teams the terms of the agreement, but that the official current version must be obtained from FEGA prior to signing (i.e. this version cannot be used to sign).
Reason
It is helpful for interested nodes to have access to the Collaboration Agreement early on so that they can understand the responsibilities for joining FEGA. It is also useful to have it early to share with an interested node's legal teams so they can have plenty of time to read and understand it before signing.
Location
No specific location, but see below for a discussion of where to place the information.
Change
My suggestion is that we define a simple "lessons learned template" where the nodes can briefly summarise their experiences. The headings could look something like this:
I think it is important to keep the text short, so we may want to put restrictions on the number of words under each section. I also think we should avoid adding lessons learned from too many nodes about the same thing.
I'm not sure where this information would be most suitable, but it could be placed under individual topics. The lessons learned regarding outreach and training for example could then be a single file with a structure looking something like this:
Reason
Location
On the website landing page, in the "path for becoming a full Federated EGA member" diagram, where it mentions "Present use case to ELIXIR FHD Community".
Change
Feedback from nodes reviewing the materials indicates it is not clear what needs to be presented here. There have been requests for requirements and instructions for what to present. It would be useful to:
Example wording for point 1:
"Nodes are encouraged to present on topics related to: 1) national use cases for managing sensitive human omics, phenotype, and clinical data; 2) current challenges for managing sensitive human data; 3) solutions/initiatives planned or in progress to meet these challenges; and 4) how Federated EGA fits in to the node's overall goals."
Some examples for point 2:
Reason
Explaining in more detail and providing example presentations for this step in the "path to becoming a full FEGA member" would be beneficial to interested nodes so that they can prepare an appropriate presentation. It would help guide them in explaining their node's use case to the FHD community, and engage more efficiently with the FHD/FEGA communities. This information (and examples) is not secret, so it can definitely be shared in the onboarding materials website.
Location
Probably the landing page, but this could also be a new page.
Change
Add some content describing why someone might want to join FEGA, what the benefits/value is, etc. The benefits/value could be described in both a theoretical/abstract way (e.g. "Improve FAIRness, increase data re-use value) and a tangible way (e.g. nodes describing specific value they gain from being part of FEGA).
Also include in here how FEGA fits into the wider picture across Europe and beyond in the content of 1+MG, B1MG, GDI, EHDS, etc.
Reason
The three key questions we want these materials to answer are: 1) What is FEGA, 2) Why should I join, and 3) How do I join. So far, the materials focus on the What and How questions, but not so much the why. We don't want to assume everyone who reads these materials has already decided they do want to join FEGA. Therefore, we need to articulate what the benefits are of joining and what value someone would get from joining.
Content addition
Replace this:
Perform a self-assessment of your node against the Maturity Model (link coming soon!).
With this:
Perform a self-assessment of your node against the FEGA Maturity Model. Use this link to create a copy of the Federated EGA Maturity Model Self-Evaluation Google spreadsheet which is private to you and whoever you share it with. This tool is meant to be an evolving evaluation of your node's progress in each of the FEGA Maturity Model domains and sub-domains, and it supports providing feedback on the FEGA Maturity Model and the tool itself if you choose to share it.
After the inaugural nodes did a first round of self-assessment against the FEGA MM, there was some feedback on how to make the tool easier to use and more understandable. We want to include this information (the tools itself plus some narrative text describing what the tool is and how to use it) in the FEGA onboarding materials to help nodes do their own self-assessment again the MM.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.