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 listing of tagged pages #408

Closed
bedroesb opened this issue Feb 12, 2021 · 24 comments · Fixed by #423
Closed

Improve listing of tagged pages #408

bedroesb opened this issue Feb 12, 2021 · 24 comments · Fixed by #423
Assignees
Labels
idea-for-discussion This can be used for inviting discussion from collaborators or community in general outreach Topics to reach out to the community

Comments

@bedroesb
Copy link
Member

bedroesb commented Feb 12, 2021

Current situation for most pages:

Screenshot from 2021-02-18 14-53-07

except for the researcher role page:

Screenshot from 2021-02-18 16-12-18

The option of using questions like in the researcher page is not sustainable and also not possible to automate. Something that would be possible is to add an extra line to the linked pages as extra information.

This extra line can be a question:

Screenshot from 2021-02-18 15-48-24

Or my personal favorite, a small description/sentence about the question(s) that are tackled in the problem:

Screenshot from 2021-02-18 16-11-59

@bedroesb bedroesb added enhancement idea-for-discussion This can be used for inviting discussion from collaborators or community in general outreach Topics to reach out to the community labels Feb 12, 2021
@bedroesb
Copy link
Member Author

The goal of giving a one-liner after the link would be to make it more inviting to click on it, like a little hint what it is about. Sou it does not look like a list of words with not much effort behind it

@bedroesb
Copy link
Member Author

these one-liners would be part of the metadata of the given pages, and do not need (but could be) to be visualized on the given pages itself.

@bedroesb bedroesb self-assigned this Feb 18, 2021
@wittigue
Copy link
Collaborator

I like the second option with the short description instead of questions. It would be great to have it as hidden metadata for the pages.

@martin-nc
Copy link

Both options are an improvement, I think. Perhaps the main thing is that the phrase explains the benefit the user will get from visiting the page, what problem will it solve. I would use a colon rather than a dash and not capitalise the description. It just looks neater to me:

Data protection: ensure your research data complies to GDPR.

@bedroesb
Copy link
Member Author

@martin-nc Also good for me!
Now we just need volunteers to write the lines :D

@wittigue
Copy link
Collaborator

I can do that.
We only need that for the problem pages, right?

@bedroesb
Copy link
Member Author

bedroesb commented Feb 19, 2021

@wittigue them for sure, I don't know whether cycle pages are listed? @floradanna do you know that?

@floradanna
Copy link
Collaborator

floradanna commented Feb 19, 2021

Currently, only Problem pages are automatically listed in Life Cycle pages and in Role-Data steward pages. So, we would need description sentence only for problem pages.

In Role-Researcher page, the last two bullet points refer to different places:

  • capture --> Collecting page in Life Cycle. So, this sentence will be lost.
  • my country --> ELIXIR website. So, this sentence will be lost, but the same link is already used in the same page ("Identify and contact the data steward in your local organisation or your national contact in the ELIXIR network").

@bedroesb
Copy link
Member Author

@floradanna and @wittigue this #423 will allows to give a description in the metadata in this form:

---
title: Compliance monitoring & measurement
tags: [plan, researcher, data manager, policy officer] 
contributors: [Christophe Trefois, Wei Gu, Pinar Alper]
description: a description
---

@bedroesb
Copy link
Member Author

The easiest way might be to do it in this spreadsheet https://docs.google.com/spreadsheets/d/13vpg0T-Qf4EM3dAgJ0LSpuH8IbuuxVk_IgjA2LyYbuw/edit#gid=0

@wittigue
Copy link
Collaborator

my suggestions for the short descriptions of tagged pages.

Compliance monitoring: Measure and document data management capabilities
Data analysis: Best practices for data analysis
Data classification: Identify the type of your research data
Data Management Plan: How to write a Data Management Plan
Data organisation: Best practices to name and organise your research data
Data protection: Ensure your research data complies to GDPR
Data publication: Prepare your data and find repositories for publication
Data quality: Ensure high quality research data
Data transfer: How to transfer large data files
Licensing: Consider licensing your research data
Metadata management: Find metadata standards and vocabularies
Data storage: How to find storage solutions

@bedroesb
Copy link
Member Author

thanks @wittigue I wonder in which form we will display it?

  1. Data protection: ensure your research data complies to GDPR.
  2. Data protection - Ensure your research data complies to GDPR

@wittigue
Copy link
Collaborator

I think I would prefer the second:
Data protection - Ensure your research data complies to GDPR

@bedroesb
Copy link
Member Author

or there other people that have a preference on this? @pinarpink @lauportell @floradanna @smza ?

@lauportell
Copy link
Contributor

I would prefer the sentence better than the question I think. Makes it easier to understant what will be the content of the pages in my opinion.

@floradanna
Copy link
Collaborator

Personally, I prefer the style proposed by Martin "Data protection: ensure your research data complies to GDPR.", but both are fine.

I would propose the following changes to the sentences:
Compliance monitoring: measure compliance to DM regulations and standards.
Data analysis: how to make data analysis FAIR.
Data classification: identify the type of your research data.
Data Management Plan: how to write a Data Management Plan (DMP).
Data organisation: best practices to name and organise your research data.
Data protection: ensure your research data complies to GDPR.
Data publication: prepare your data and find repositories for publication.
Data quality: ensure high quality research data.
Data transfer: how to transfer data files.
Licensing: how to license research data.
Metadata management: find metadata standards and vocabularies.
Data storage: how to find appropriate storage solutions.

@lauportell
Copy link
Contributor

I like your descriptions Flora, only I wouldn't say 'your' in the sentences, I would leave it neutral. Maybe also I would write data management instead of DM for compilance monitoring.

@floradanna
Copy link
Collaborator

Are these ok? Can we implement them?

Compliance monitoring: measure compliance to data management regulations and standards.
Data analysis: how to make data analysis FAIR.
Data classification: how to identify different research data types.
Data Management Plan: how to write a Data Management Plan (DMP).
Data organisation: best practices to name and organise research data.
Data protection: how to make research data compliant to GDPR.
Data publication: prepare data and find repositories for publication.
Data quality: ensure high quality research data.
Data transfer: how to transfer data files.
Licensing: how to license research data.
Metadata management: find metadata standards and vocabularies.
Data storage: how to find appropriate storage solutions.

@bedroesb
Copy link
Member Author

bedroesb commented Feb 25, 2021

Yes, will do it now, just to be sure, we do it this way:
Compliance monitoring: measure compliance to data management regulations and standards.
and not

Compliance monitoring: Measure compliance to data management regulations and standards.

@bedroesb bedroesb reopened this Feb 25, 2021
@bedroesb
Copy link
Member Author

woops misclicked, yes, will implement these sentences in my PR #423

@floradanna
Copy link
Collaborator

yes, correct.

@bedroesb
Copy link
Member Author

Screenshot from 2021-02-25 14-51-44

@bedroesb bedroesb linked a pull request Feb 25, 2021 that will close this issue
@lauportell
Copy link
Contributor

I see in the screenshot that in metadata management it says 'ind' instead of 'find'

@wittigue
Copy link
Collaborator

I fixed it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
idea-for-discussion This can be used for inviting discussion from collaborators or community in general outreach Topics to reach out to the community
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants