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

Improve the concept of "resources" in the RDMkit #1532

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Conversation

bedroesb
Copy link
Member

@bedroesb bedroesb commented Sep 26, 2024

This will close #1518

  • Choosing a more neutral icon for the tools in the text
    image
  • Define what resources are with examples in our contribute documentation

@bianchini88
Copy link
Collaborator

@bedroesb I do not think it is up to me to approve the new icon. If we really want to close #1518 we should also expand the documentation. I can have a go at it, but not before the 17th of October.

@bedroesb
Copy link
Member Author

bedroesb commented Oct 7, 2024

I agree, this needs more thought than just the icon.

@bedroesb
Copy link
Member Author

bedroesb commented Dec 30, 2024

Based on the editorial meetings, an info icon fits best the purpose of the clickable 'buttons'.
Some variants:

image

image

image

image

image

image

@bianchini88
Copy link
Collaborator

I do like the ones with the colour filling and intermediate "i" sizes.

@bedroesb
Copy link
Member Author

@bianchini88 I've added some numbers, makes it easier :) I am also adding a paragraph to the 'Update a tool or resource''

@bianchini88
Copy link
Collaborator

Thanks @bedroesb, I actually struggled to understand how many variations we had. I would say 3>1>2>4 (but please ask someone with a better graphic sense than me).

@bedroesb
Copy link
Member Author

I added 2 more, my current favorites are 3 and 6

@bedroesb bedroesb marked this pull request as ready for review December 30, 2024 16:36
@bedroesb bedroesb requested a review from floradanna as a code owner December 30, 2024 16:36
@bedroesb
Copy link
Member Author

@elixir-europe/rdmkit-editors I added 6 options for an icon above and updated the Add a new tool or resource contribute page be more clear about when a tool should be added to the tools table. Did I forget things or remember things wrongly? Please do give feedback. I might also use the word main YAML file to much ....

@Nazeeefa
Copy link
Collaborator

I am afraid I can't vote for any of the icon options for tools and resources because I like the current gear icon 😄 The "i" icon suggests, to me at least, that hovering over icon will give me a brief information and I do not expect anything more.

@diana-pilvar
Copy link
Collaborator

if only used for tools, I like the gear. If the links also cover resources, gear is not optimal.
I don't like the box.
For the I's : 4,3 >1>2,4
6 reminds me of biohazard

@bedroesb bedroesb requested a review from a team January 2, 2025 15:13
pages/contribute/tool_resource_update.md Outdated Show resolved Hide resolved
pages/contribute/tool_resource_update.md Outdated Show resolved Hide resolved

The [all_tools_and_resources](all_tools_and_resources) list is based on the [yaml file](https://github.com/elixir-europe/rdmkit/blob/master/_data/tool_and_resource_list.yml) in the `_data` directory of the RDMkit repository. Tools and resources can be manually linked to [FAIRsharing.org](https://fairsharing.org/), [Bio.tools](https://bio.tools) and [TeSS](https://tess.elixir-europe.org/), but every week we also run a fully automatic check that links tools and resources with the corresponding registries. A GitHub Bot will generate a Pull Request (PR) with the new links added to the main data file of the website.
{% include callout.html type="important" content="The link with FAIRsharing, TeSS and Bio.tools is automatically done using GitHub Actions and is updated weekly. If no FAIRsharing ID, Bio.tools ID or TeSS query is available for a source, but there is yet one automatically given (faulty), you can overwrite the automatic linking by adding `NA` as a registry." %}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe be a bit more specific than "the link... is done".

but there is yet one automatically given (faulty)

This is not very clear...


Each tool or resource mentioned in the text has metadata stored in the [main yaml file](https://github.com/elixir-europe/rdmkit/blob/master/_data/tool_and_resource_list.yml). The metadata block for each tool consists of 5 attributes:
Tools and resources mentioned in the text of the pages should be included in the main table. However, not everything qualifies as a tool or resource in the context of RDMkit. Specifically, the following are **not** considered tools or resources:
- **Publications**: Articles, white papers, or other academic literature.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pages/contribute/tool_resource_update.md Outdated Show resolved Hide resolved
pages/contribute/tool_resource_update.md Outdated Show resolved Hide resolved
pages/contribute/tool_resource_update.md Outdated Show resolved Hide resolved
pages/contribute/tool_resource_update.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

A clearer definition of "resources"
4 participants