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

Update task page template #169

Merged
merged 6 commits into from
Dec 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 31 additions & 25 deletions pages/your_tasks/TEMPLATE_your_tasks.md
Original file line number Diff line number Diff line change
@@ -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
---
<!-- Please take in mind our style guide https://rdmkit.elixir-europe.org/style_guide when writing the content of this page. -->

## Concrete problem 1, formulated as a question <!-- example: how to version control my code? -->
## Concrete problem 1, formulated as a question <!-- example: how to version control code? -->

### Description <!-- do not delete this heading and write your text below it -->

Short explanation of what this problem is about.
Short explanation of what the problem is about.

### Considerations <!-- do not delete this heading and write your text below it -->

* [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 <!-- do not delete this heading and write your text below it -->

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 <!-- example: how to name a software release? -->
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 <!-- example: how to use GitHub to share code ? -->

### Description <!-- do not delete this heading and write your text below it -->
Same as above

### Considerations <!-- do not delete this heading and write your text below it -->
Same as above

### Solutions <!-- do not delete this heading and write your text below it -->

## How to cite this page <!-- do not delete this heading and write your text below it -->
contributors, page URL. Last date of access.

## Tools and resources <!-- do not delete this heading and write your text below it -->
List of relevant tools and resources for this task.

## References <!-- do not delete this heading and write your text below it -->
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 <!-- do not delete this heading and write your text below it -->
Add a citation entry for this specific page, if it exists.

Loading