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

Description of the metadata in Grist #798

Open
Ly0n opened this issue Aug 30, 2024 · 4 comments
Open

Description of the metadata in Grist #798

Ly0n opened this issue Aug 30, 2024 · 4 comments
Labels
dev/front-end documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Ly0n
Copy link
Member

Ly0n commented Aug 30, 2024

For the grist spreadsheet a description of the various metadata could help user a lot to understand the source / calculation of various values we are showing. Such a description could be added manually via the Grist front-end, or ideally should be added to the Python script that creates the columns in the first place, so that this data is stored in a repository and can be easily recreated.

@Ly0n Ly0n added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers dev/front-end labels Aug 30, 2024
@DeeptiN1
Copy link
Contributor

Hi, is this open? How can I make a contribution to the documentation here?

@Ly0n
Copy link
Member Author

Ly0n commented Dec 21, 2024

Hey @DeeptiN1, thank you for taking on this issue. A good way to get started would be to create a markdown table defining all the metadata that you can see in the spreadsheet.

Here some documents that are relevant for the work.
Spreadsheet: https://docs.getgrist.com/doc/gSscJkc5Rb1Rw45gh1o1Yc
Here the script that pulls data from the ecosystem.ms service. Some data from ecosyste.ms is just forwarded but other parts are just data is been created inside this script: https://github.com/protontypes/open-sustainable-technology/blob/main/.github/workflows/ecosystems_to_grist.py

The backend source can be find here: https://github.com/ecosyste-ms/ost
The api documentation can be found here. So far not all available data is documented by Ecosyste.ms.: https://ost.ecosyste.ms/docs/index.html

To get started, it would be very helpful if you could simply write what you think this data describes for each column of the projects and organisations. This would help us to understand where the naming of the values might already be totally off. If you make a first serve I can support you further.

@andrew andrew changed the title Discription of the metadata in Grist Description of the metadata in Grist Dec 21, 2024
@DeeptiN1
Copy link
Contributor

Hey @DeeptiN1, thank you for taking on this issue. A good way to get started would be to create a markdown table defining all the metadata that you can see in the spreadsheet.

Here some documents that are relevant for the work. Spreadsheet: https://docs.getgrist.com/doc/gSscJkc5Rb1Rw45gh1o1Yc Here the script that pulls data from the ecosystem.ms service. Some data from ecosyste.ms is just forwarded but other parts are just data is been created inside this script: https://github.com/protontypes/open-sustainable-technology/blob/main/.github/workflows/ecosystems_to_grist.py

The backend source can be find here: https://github.com/ecosyste-ms/ost The api documentation can be found here. So far not all available data is documented by Ecosyste.ms.: https://ost.ecosyste.ms/docs/index.html

To get started, it would be very helpful if you could simply write what you think this data describes for each column of the projects and organisations. This would help us to understand where the naming of the values might already be totally off. If you make a first serve I can support you further.

Hi @Ly0n Thank you very much for sharing all the details. I am eager to start on this. However, I have an update regarding the timeline. I have to travel and will be away from December 22 to January 03, with limited internet access. I am sorry for the inconvenience but I will definitely be able to work on this after I'm back.

@DeeptiN1
Copy link
Contributor

I have created PR #1025 for review to start with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev/front-end documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants