diff --git a/pages/your_tasks/TEMPLATE_your_tasks.md b/pages/your_tasks/TEMPLATE_your_tasks.md index beb481bc..b4ed1c92 100644 --- a/pages/your_tasks/TEMPLATE_your_tasks.md +++ b/pages/your_tasks/TEMPLATE_your_tasks.md @@ -1,56 +1,62 @@ --- -title: "A title for the task or a problem you are trying to solve" +title: "A title for the task or a problem you are trying to solve" # short title search_exclude: true # set to false if you want this page to show up in search results -description: "" # Add a short description of the page -contributors: [] # A comma separated list of contributors' ids +description: "" # a description of the page +contributors: [] # a comma separated list of contributors' names, as found in _data/CONTRIBUTORS.yml page_id: # unique page id, e.g. lowercase title words separated by underscore(s) - for example page_id of 'version control' page could be version_control related_pages: [] # A comma-separated page_ids of the pages that are related to the current page -training: +training: # A list of training resources relevant for this task or problem (e.g from TeSS registry or elsewhere) - name: registry: url: -# More information on how to fill in this metadata section can be found here https://rdmkit.elixir-europe.org/page_metadata --- - -## Concrete problem 1, formulated as a question - +## Concrete problem 1, formulated as a question + ### Description -Short explanation of what this problem is about. +Short explanation of what the problem is about. ### Considerations -* [Structured in bullet points](style_guide#text) as much as possible, detailing things to consider about this problem in order to be able to find the right solution. +Detail things to consider about this problem in order to be able to find the right solution - e.g. using a bullet point list. + +- Consideration 1 +- Consideration 2 + - Sub-point +- Consideration 3 + - Sub-point + - Sub-point ### Solutions -By using [bullet point style](style_guide#text) as much as possible, try to describe when, why and for what is best to use a specific tool or resource. -Avoid making long list of links to tools and resources. -Make sure to add the tools and resources mentioned in the text in the main "tools and resources" table. +Briefly describe the use of specific tools or resources to solve the problem - e.g. using a bullet point list. -* Bullet point solution 1 - * Sub-point -* Bullet point solution 2 +- Solution 1 + - Sub-point +- Solution 2 +Make sure to add the tools and resources mentioned in the text in the [_data/tool_and_resource_list.yml](_data/tool_and_resource_list.yml) file and then +tag the page with such entries. -## Concrete problem 2, formulated as a question +Repeat the same structure for other problems you wish to mention on the page, as needed, e.g. as follows. + +## Concrete problem 2, formulated as a question ### Description -Same as above ### Considerations -Same as above ### Solutions -## How to cite this page - contributors, page URL. Last date of access. - -## Tools and resources -List of relevant tools and resources for this task. ## References -If work has been inspired or derived from other content (e.g., pages in RDMKit) make sure to reference it here. +If this page has been inspired or derived from other resources, make sure to reference them here. + +There is no need to reference other relevant pages from RSQKit here - rather list them in the page's *frontmatter* +using parameter `related_pages` and they will be listed in the page automatically under "Related pages" section. + +## How to cite this page +Add a citation entry for this specific page, if it exists.