Skip to content
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

Updated topic content to enhance clarity (Fixes Issue #20) #22

Merged
merged 13 commits into from
Aug 8, 2022

Conversation

malloryfreeberg
Copy link
Contributor

Changes made:

  1. Gov & Legal page
    • Use Cases: Added sentence explaining the Use Cases are other resources joining FEGA.
    • Organisation: Added missing "Central" to "EGA Strategic Committee”
  2. Tech & Ops page
    • Software: Clarified that installing localEGA software is optional
    • Shared FEGA - CEGA SOPs: Clarified communication between CEGA and FEGA
    • Evaluate implementation: Added link to the "Maturity Model" page
  3. Establishing a FEGA Node (main) page
    • Added sentence to clarify use of Maturity Model and linking to the page.
    • In the table: Clarified discovery responsibility of CEGA and FEGA nodes
    • How do I start: Skipped these changes in this PR; already addressed in PR More readable text with list of general topics #19

@malloryfreeberg malloryfreeberg requested a review from ainajene July 29, 2022 11:07
@malloryfreeberg malloryfreeberg added the documentation Improvements or additions to documentation label Jul 29, 2022
@malloryfreeberg malloryfreeberg linked an issue Aug 2, 2022 that may be closed by this pull request
Copy link
Collaborator

@M-casado M-casado left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just a few suggestions.

docs/index.md Outdated Show resolved Hide resolved
@@ -35,14 +35,14 @@ Genetic data generated in a healthcare context is subject to more stringent info

### Use cases

Understand more about the current [use cases and architecture for the Federated EGA](https://zenodo.org/record/4893063) as reported by the inaugural Federated EGA nodes.
Understand more about the current [use cases and architecture for the Federated EGA](https://zenodo.org/record/4893063). Here you can read about the requirements and national use cases of early engaged Federated EGA Nodes which aim to be addressed by joining the Federated EGA. The report also describes how specific use cases can be supported by Federated EGA, for example by a governance structure made up of permanent committees and ad hoc working groups, the use of global and community standards, and guidelines for how data/metadata can be shared within the network.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Understand more about the current [use cases and architecture for the Federated EGA](https://zenodo.org/record/4893063). Here you can read about the requirements and national use cases of early engaged Federated EGA Nodes which aim to be addressed by joining the Federated EGA. The report also describes how specific use cases can be supported by Federated EGA, for example by a governance structure made up of permanent committees and ad hoc working groups, the use of global and community standards, and guidelines for how data/metadata can be shared within the network.
Understand more about the current [use cases and architecture for the Federated EGA](https://zenodo.org/record/4893063). Here you can read about the requirements and national use cases of early engaged Federated EGA Nodes which aim to be addressed by joining the Federated EGA. The report also describes how specific use cases can be supported by Federated EGA. For example, by a governance structure made up of permanent committees and ad hoc working groups, the use of global and community standards, and guidelines for how data/metadata can be shared within the network.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer to keep this as is to avoid incomplete sentences.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase just seemed a bit too long, but it's understandable anyway

docs/topics/technical-operational/index.md Outdated Show resolved Hide resolved
docs/topics/technical-operational/index.md Outdated Show resolved Hide resolved
- Evaluate ability to scale services by performing [stress tests](TBD)
- Demonstrate the full set of FEGA node services for users by planning your [FEGA end-to-end demonstrator](https://docs.google.com/document/d/1m7WDC112e73Kw79baZcsRsQOkAAGKtp_AiqJRhrgtUk/edit?usp=sharing)
- Understand the domains in which a node matures using the [Federated EGA Maturity Model](https://ega-archive.github.io/FEGA-onboarding/topics/maturity-model/)
- Assess the technical and operational maturation of your node by doing a **self-assessment against the Federated EGA Maturity Model** (Coming soon!)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it still coming soon? Didn't Albert show it during our meeting at BSC?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if the version of the self-assessment tool that was provided to the inaugural nodes is the final version that will be shared with anyone. I'll leave it to Albert et al. to update this point at a later date.

@malloryfreeberg malloryfreeberg merged commit f2f111f into main Aug 8, 2022
@malloryfreeberg malloryfreeberg deleted the docs/issue-1-update_topic_content branch August 8, 2022 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Suggestions for changes to topics content to improve clarity
2 participants