draft of data workflow diagram task #1528
Conversation
vildead
requested review from
wittigue,
floradanna,
smza,
marikapop,
Nazeeefa and
diana-pilvar
as code owners
|
I still plan to find nice example of such a diagram (maybe even two - one simple and one complex) Also, I am not sure the page fits to RDMKit or it would be better to have it in FAIRCookbook (or both to some extend). |
|
Thanks @vildead 🤩 I think the title should be "Creating a data workflow" so that it suggests how to visualise your project data in a workflow (diagram). Current title "data workflow diagram" suggests, to me at least, that the page will include specific diagram that I am being suggested/recommended to use for my datasets. |
|
@Nazeeefa thanks for the suggestions! I have implemented the changes. |
pages/data_life_cycle/planning.md
Outdated
| @@ -4,7 +4,7 @@ page_id: plan | |||
| description: Introduction to data management planning. | |||
| contributors: [Siiri Fuchs, Korbinian Bösl, Minna Ahokas, Federico Bianchini, Flora D'Anna] | |||
| related_pages: | |||
| your_tasks: [compliance, costs, dmp, data_security, dm_coordination, machine_actionability] | |||
| your_tasks: [compliance, costs, dmp, data_security, dm_coordination, machine_actionability, data_workflow_diagram] | |||
There was a problem hiding this comment.
@vildead can you also kindly update name here?
_data/news.yml
Outdated
| @@ -194,3 +194,7 @@ | |||
| date: 2024-10-24 | |||
| linked_pr: 1526 | |||
| description: The page is enriched with additional links and a bibliography. [Discover the page here](human_pathogen_genomics). | |||
| - name: "New page: Data workflow diagram" | |||
There was a problem hiding this comment.
@bedroesb can you kindly update page name here after "News page"? The new name is "Creating Data Workflow"
|
Very nice! I have added some suggestions. Adding example(s) of data flow diagram would make it even better! |
| faircookbook: | ||
| --- | ||
|
|
||
| ## How should you draw a data workflow diagram? |
There was a problem hiding this comment.
| ## How should you draw a data workflow diagram? | |
| ## How to draw a data workflow diagram? |
|
|
||
| ### Considerations | ||
|
|
||
| * A simple diagram can significantly improve clarity and communication and it's essential to first consider the complexity of the workflow. For complex project with multiple steps, data sources, or stakeholders, a diagram is invaluable for identifying steps, dependencies, potential issues and ensuring everyone has a shared understanding. |
There was a problem hiding this comment.
| * A simple diagram can significantly improve clarity and communication and it's essential to first consider the complexity of the workflow. For complex project with multiple steps, data sources, or stakeholders, a diagram is invaluable for identifying steps, dependencies, potential issues and ensuring everyone has a shared understanding. | |
| * A simple diagram can significantly improve clarity and communication and it's essential first to consider the complexity of the workflow. For complex project with multiple steps, data sources, or stakeholders, a diagram is invaluable for identifying steps, dependencies, potential issues and ensuring everyone has a shared understanding. |
|
|
||
| * A simple diagram can significantly improve clarity and communication and it's essential to first consider the complexity of the workflow. For complex project with multiple steps, data sources, or stakeholders, a diagram is invaluable for identifying steps, dependencies, potential issues and ensuring everyone has a shared understanding. | ||
| * The more complex the workflow, the more time and effort it will take to create and update the diagram. It is important to plan carefully and ensure that the time invested in diagram creation and updates is manageable and that your contribution is clearly recognized. | ||
| * A diagram may include sensitive or confidential information or reveal critical details that could be exploited by attackers, such as system vulnerabilities or data access points. Therefore, be cautious about sharing information publicly. Ensure that appropriate security measures are in place and such information is properly protected to prevent security breaches. |
There was a problem hiding this comment.
would be good to provide a link to examples of these security measures
|
thank you @jennytdtran I think this pull request got a bit pre maturely merged. I agree with your suggestions, and will try to bring them still in. @vildead I now just nottice that creating a data workflow gives a wrong impression to the page. We do not describe how to make a workflow, but how to make a diagram. Can we change the title/page to creating a workflow diagram? |
@Nazeeefa I do not agree with this I am afraid. Making a workflow gives the impression this is data analysis related, while in reality it is how to make a diagram. @elixir-europe/rdmkit-editors other opinions? |
|
@bedroesb I think we are thinking along the same lines - my first feedback was about the initial title which was missing the keyword creating. I agree with you that "diagram" is also a keyword. Sorry I was focused more on making sure to give readers a right impression that we are talking about how to create not that specific material is provided for download/reuse. |
|
I'm looking at the published page and wondering why the specific solution steps are not in the cookbook as a recipe. |
|
It could certainly go there! I feel the cookbook page will need more detailed description with graphical examples of each step. |
|
I have created an issue in Faircookbook: FAIRplus/the-fair-cookbook#637 |
No description provided.