Grist spreadsheet metadata (column name) definitions/descriptions #1025
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
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?