From 6391601c48e06fb76511e1625d7b88a749c9d2b6 Mon Sep 17 00:00:00 2001 From: Wout Bittremieux Date: Mon, 2 Sep 2024 21:14:31 +0200 Subject: [PATCH] Add meeting notes August 21 --- meeting_notes/2024/20240821_telco.md | 47 ++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 meeting_notes/2024/20240821_telco.md diff --git a/meeting_notes/2024/20240821_telco.md b/meeting_notes/2024/20240821_telco.md new file mode 100644 index 0000000..4c12f71 --- /dev/null +++ b/meeting_notes/2024/20240821_telco.md @@ -0,0 +1,47 @@ +# QC working group teleconference 21 August 2024 + +- Chris Bielow +- Wout Bittremieux +- Mathias Walzer + +--- + +## Website updates + +- Discussion on recent updates to the website, including changes to various pages like metrics, specifications, use cases, and validation processes. +- Identified some inconsistencies and incomplete updates on the website, particularly in the metrics section. + +### Navigation and structure + +- The current navigation menu was found to be confusing due to redundant links and overlapping content. +- Remove redundant links from the top menu and ensure that each menu item corresponds to a single, clear page. +- Rename some menu items for clarity, such as changing "Format" to "Introduction" or "Overview" under the "For Users" section. + +## Categorization + +- The idea to create two main categories: "For Developers" and "For Users," was discussed to differentiate between technical and non-technical content. +- "For Developers" would include technical documentation, specifications, and validation, while "For Users" would focus on use cases and software applications. + - Move less technical content, such as omics-specific information, to the "For Users" section, and keep technical documentation under "For Developers." + +## Content specificity + +- Consideration of the need to separate content specific to different types of omics (proteomics, metabolomics, lipidomics) to better target different communities. +- Discussion on the importance of keeping examples and use cases up to date and consistent with the current specifications. + - Ensure that the example files are automatically validated using GitHub Actions. + +## Action items + +Content review and update: + +- Review and update the metrics page to ensure completeness and accuracy. +- Create a standalone "Use Cases" page separate from the omics content. + +Navigation overhaul: + +- Redesign the website navigation to reflect the new categorization, ensuring a clear distinction between developer-focused and user-focused content. +- Rename menu items as discussed (e.g., "Format" to "Introduction" or "Overview"). + +Technical improvements: + +- Implement a semantic validation process in GitHub actions to automatically check the correctness of examples and other technical content. +- Explore possible solutions for ensuring link validity and overall content consistency on the website.