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

structured data on codebase landing pages + codemeta integration #351

Open
alee opened this issue May 18, 2018 · 6 comments
Open

structured data on codebase landing pages + codemeta integration #351

alee opened this issue May 18, 2018 · 6 comments
Labels
feature open science issues related to other open science initiatives

Comments

@alee
Copy link
Member

alee commented May 18, 2018

Each codebase release should have its own specific CodeMeta associated with it. Embed structured json-ld data in the landing page, and provide it in the downloaded archive.

Google's schema.org testing tool (ignore warning about deprecation - https://developers.google.com/search/blog/2020/07/rich-results-test-out-of-beta):

https://search.google.com/structured-data/testing-tool/u/0/

https://search.google.com/test/rich-results

@alee alee added feature open science issues related to other open science initiatives labels May 18, 2018
@alee alee changed the title generate up to date codemeta based on codebase metadata codemeta integration May 18, 2018
@alee
Copy link
Member Author

alee commented Aug 30, 2018

https://codemeta.github.io/user-guide/

List of codemeta terms we should be mapping our metadata onto: https://codemeta.github.io/terms/

https://github.com/proycon/codemetapy

@alee
Copy link
Member Author

alee commented May 9, 2019

Example codemeta from codemeta: https://github.com/codemeta/codemeta/blob/master/codemeta.json

Example codemeta from ASCL: https://ascl.net/1010.051/codemeta.json

@alee
Copy link
Member Author

alee commented Nov 13, 2019

alee added a commit that referenced this issue Nov 14, 2019
minor refactoring, need to still run `fs_api.add_codemeta()` to add to
the FS
@alee
Copy link
Member Author

alee commented Nov 19, 2019

The root object is an instance of https://schema.org/SoftwareSourceCode

  • add a targetProduct that is an instance of https://schema.org/SoftwareApplication
  • provide additional properties where possible, for example the SoftwareSourceCode discussionUrl should point to the related Discourse comments page this would require some hacking since the discourseEmbed is generating that link..
  • add softwareRequirements properties based on captured dependencies (from stencila/dockta?)

@alee alee changed the title codemeta integration structured data on codebase landing pages + codemeta integration Nov 20, 2019
@alee
Copy link
Member Author

alee commented Dec 2, 2021

discussionUrl can be set by querying the discourse endpoint /embed/info

Example:

curl 'https://meta.discourse.org/embed/info?embed_url=https://blog.discourse.org/2021/04/discourse-team-grows-to-50' -H 'API-KEY: logapikeygoeshere' -H 'API-USERNAME: apiusernamehere' 

Response:

{
  "topic_id": 187794,
  "post_id": 925017,
  "topic_slug": "discourse-team-grows-to-50-blog",
  "comment_count": 2
}

The embed_url should be the permanent_url for the codebase landing page, and the response we get can be parsed for the topic_id to generate a forum.comses.net/t/<topic_id> link to include as the discussionUrl.

From

https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963/394

@alee
Copy link
Member Author

alee commented Apr 11, 2022

add dedicated sponsors and funding fields to Codebase metadata as well as emitted codemeta

hwelsters pushed a commit to hwelsters/comses.net that referenced this issue May 10, 2023
minor refactoring, need to still run `fs_api.add_codemeta()` to add to
the FS
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature open science issues related to other open science initiatives
Projects
None yet
Development

No branches or pull requests

1 participant