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

Grist spreadsheet metadata (column name) definitions/descriptions #1025

Merged
merged 3 commits into from
Jan 21, 2025

Conversation

DeeptiN1
Copy link
Contributor

@DeeptiN1 DeeptiN1 commented Jan 11, 2025

Issue
Github issue: #798 (comment)

Discussed solution
As per #798 (comment), to start with, created a Markdown table with the Grist spreadsheet metadata descriptions/definitions to help the user to understand the source of the provided values.

References
Grist spreadsheet: https://docs.getgrist.com/doc/gSscJkc5Rb1Rw45gh1o1Yc
Script: https://github.com/protontypes/open-sustainable-technology/blob/main/.github/workflows/ecosystems_to_grist.py
Backend source: https://github.com/ecosyste-ms/ost

Screenshot
Screenshot_markdown_table

Notes
Some questions that came up while I was writing the definitions:

  • For the "Organizations" sheet, should column "organization_projects" be renamed as "organization_project_urls" since the values are URLs for repositories on platforms like GitHub?

  • Similarly, for the "Funding" sheet, should column "website" be renamed as "repository_url" since the values are URLs for repositories on platforms like GitHub?

Reviewers
@Ly0n please could you review?

Small improvements to the metadata description that were not obvious.
@Ly0n
Copy link
Member

Ly0n commented Jan 12, 2025

Thanks @DeeptiN1. You made an fantastic contribution that is very helpful. I have made some minor improvements to make the description even more accurate.

@andrew We should rename "funding links" to donation links. Many people might think that the links we collect are about the ‘source’ of funding such as grants, etc. We have discussed doing this in the future, but to avoid any confusion with the donation links, let's find a better wording here to differentiate them.

@Ly0n Ly0n requested a review from andrew January 12, 2025 11:21
@Ly0n
Copy link
Member

Ly0n commented Jan 12, 2025

@DeeptiN1

For the "Organizations" sheet, should column "organization_projects" be renamed as "organization_project_urls" since the values are URLs for repositories on platforms like GitHub?

Similarly, for the "Funding" sheet, should column "website" be renamed as "repository_url" since the values are URLs for repositories on platforms like GitHub?

Yes we should do that! This makes things much clearer.

@Ly0n
Copy link
Member

Ly0n commented Jan 21, 2025

Thanks @DeeptiN1. I'll link to the document on the front page in another PR. We have a small "Signal" group for OpenSustain.tech contributors where we share ideas, projects and discuss next steps for the project. We also have a community video call every 4 weeks. As we have just received a donation of $10000, we will use this money to produce a scientific publication and analysis based on the metadata of the organisations and projects. You are very welcome to join us in this endeavour. Just send me an email to [email protected] and I will send you an invite :).

@Ly0n Ly0n merged commit 61c0a2e into protontypes:main Jan 21, 2025
1 check passed
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.

2 participants