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

Adding more schema.org attributes to pages #726

Merged
merged 9 commits into from
Nov 12, 2021
Merged

Adding more schema.org attributes to pages #726

merged 9 commits into from
Nov 12, 2021

Conversation

bedroesb
Copy link
Member

This PR will add authors metadata to the pages using Person objects and Organisation objects for the affiliation.

Screenshot from 2021-10-29 16-33-48

This will close #597

@jburel could you have a look/compare with the work that you had done on this?

"about": "{{ site.description }}",
{%- if page.contributors %}
{%- assign contributors = site.data.CONTRIBUTORS -%}
{% for people in page.contributors %}
Copy link
Contributor

Choose a reason for hiding this comment

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

I will have expected something like

"contributor": [
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0003-0522-5674",
      "mainEntityOfPage": "https://orcid.org/0000-0003-0522-5674",
      "givenName": "Bert",
      "familyName": "Droesbeke",
      "affiliation": {
        "@type": "Organization",
        "name": "VIB-UGent / ELIXIR-BE"
      },
      "email": "[email protected]",
      "url": "https://github.com/bedroesb/",
      "image": "https://avatars.githubusercontent.com/bedroesb",
      "jobTitle": "editor"
    },

orcid is for example not available in schema.org

Copy link
Member Author

Choose a reason for hiding this comment

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

@jburel Thanks for your comment!

I used orcid from Bioschemas: https://bioschemas.org/profiles/Person/0.2-DRAFT-2019_07_19

But using it as ID makes also sense. Do you think it is a problem to leave out:

"@id": "https://orcid.org/0000-0003-0522-5674",
      "mainEntityOfPage": "https://orcid.org/0000-0003-0522-5674",

When no orcid is given?

Second question, The name of the person is at this moment name + family name in one string. I don't think I can split this in an automatic way.

Copy link
Contributor

@jburel jburel Nov 8, 2021

Choose a reason for hiding this comment

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

The only downside of the bioschema spec is that it is still a draft so we might be careful about using it.
For the case of missing orcid, we will omit ID (not ideal). Is there a field we are sure to always have?

For the name, if I understand correctly, givenName is currently misused. Should the name field of Person be used in that case to avoid misinterpretation.

Copy link
Member Author

Choose a reason for hiding this comment

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

Name (first + last name) is what we have for sure. I will make a commit implementing these suggestions, thanks!

@bedroesb
Copy link
Member Author

based on the feedback from @jburel I updated the schema.org to:

    <script type="application/ld+json">
    {
        "@context": "https://schema.org",
        "@type": "WebSite",
        "name": "RDMkit",
        "url": "http://localhost:4000",
        "about": "Find the answers to your Research Data Management questions in Life Sciences.",
        "author": {
            "@type": "Person",
            "@id": "https://orcid.org/0000-0002-4520-044X",
            "mainEntityOfPage": "https://orcid.org/0000-0002-4520-044X",
            "name": "Niclas Jareborg",
            "affiliation": {
                "@type": "Organization",
                "name": "NBIS / ELIXIR-SE"
            },
            "email": "[email protected]",
            "url": "https://github.com/nicjar",
            "image": "https://avatars.githubusercontent.com/nicjar",
            "jobTitle": "editor"
        }
        "author": {
            "@type": "Person",
            "name": "Nirupama Benis",
        }
        "author": {
            "@type": "Person",
            "name": "Ana Portugal Melo",
        }
        "author": {
            "@type": "Person",
            "@id": "https://orcid.org/0000-0002-2224-0780",
            "mainEntityOfPage": "https://orcid.org/0000-0002-2224-0780",
            "name": "Pinar Alper",
            "affiliation": {
                "@type": "Organization",
                "name": "LCSB / ELIXIR-LU"
            },
            "url": "https://github.com/pinarpink",
            "image": "https://avatars.githubusercontent.com/pinarpink",
            "jobTitle": "editor"
        }
        "author": {
            "@type": "Person",
            "@id": "https://orcid.org/0000-0003-0390-3208",
            "mainEntityOfPage": "https://orcid.org/0000-0003-0390-3208",
            "name": "Laura Portell Silva",
            "affiliation": {
                "@type": "Organization",
                "name": "Barcelona Supercomputing Center / ELIXIR-ES"
            },
            "email": "[email protected]",
            "url": "https://github.com/lauportell",
            "image": "https://avatars.githubusercontent.com/lauportell",
            "jobTitle": "editor"
        }
        "author": {
            "@type": "Person",
            "@id": "https://orcid.org/0000-0002-3890-6620",
            "mainEntityOfPage": "https://orcid.org/0000-0002-3890-6620",
            "name": "Wolmar Nyberg Åkerström",
            "affiliation": {
                "@type": "Organization",
                "name": "NBIS / ELIXIR-SE"
            },
            "email": "[email protected]",
            "url": "https://github.com/wna-se",
            "image": "https://avatars.githubusercontent.com/wna-se",
        }
        "author": {
            "@type": "Person",
            "name": "Nazeefa Fatima",
            "url": "https://github.com/Nazeeefa",
            "image": "https://avatars.githubusercontent.com/Nazeeefa",
        }
    }
</script>

@bedroesb bedroesb merged commit 96f12ae into master Nov 12, 2021
@bedroesb bedroesb deleted the bioschemas branch November 12, 2021 10:07
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.

Adding Person and Organisation metadata to website
2 participants