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

Suggestions for changes to topics content to improve clarity #20

Closed
malloryfreeberg opened this issue Jul 29, 2022 · 0 comments · Fixed by #22
Closed

Suggestions for changes to topics content to improve clarity #20

malloryfreeberg opened this issue Jul 29, 2022 · 0 comments · Fixed by #22
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@malloryfreeberg
Copy link
Contributor

Location

  1. Gov & Legal: https://ega-archive.github.io/FEGA-onboarding/topics/governance-legal/
  2. Tech & Ops: https://ega-archive.github.io/FEGA-onboarding/topics/technical-operational/
  3. Establishing a FEGA node: https://ega-archive.github.io/FEGA-onboarding/

Change

  1. Gov & Legal
    1. Use Cases: Maybe add a sentence explaining the Use Cases are other resources joining FEGA.
    2. Organisation: In "Federated EGA Strategic Committee" missing "Central EGA Strategic Committee”
  2. Tech & Ops
    1. Software: It was not cleat for me that you could use this tool to install the node, or your own tools.
    2. Shared FEGA - CEGA SOPs: Communication between CEGA and FEGA is not clear.
    3. Evaluate implementation: You could also add here the link to the "Maturity Model" documentation site.
  3. Establishing a FEGA Node
    1. Add at the end a paragraph briefly explaining the Maturity Model and linking to the page.
    2. In the table: "Shares metadata & allows global discovery" vs "Shares metadata to allow global discovery" - not clear the difference
    3. How do I start?
      1. Add a pair of sentences on the first steps, or summary of main actions to do, which will involve governance, technical, etc.
      2. Then the sections "If you are involved..."
      3. Then the option to join the ELIXIR lists, and maybe be more clear that it's strongly recommended to join.

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 :)

@malloryfreeberg malloryfreeberg added the documentation Improvements or additions to documentation label Jul 29, 2022
@malloryfreeberg malloryfreeberg self-assigned this Jul 29, 2022
malloryfreeberg added a commit that referenced this issue Aug 8, 2022
…tent

Updated topic content to enhance clarity (Fixes Issue #20)
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 a pull request may close this issue.

1 participant