oso icon indicating copy to clipboard operation
oso copied to clipboard

Populate OSS Directory with description fields

Open ccerv1 opened this issue 1 year ago • 6 comments

Describe the feature you'd like to request

As the number of projects grows, it will get harder for users to ensure they are getting data from the project they care about. We should start using the description field in OSS Directory and/or auto-populating from GitHub org descriptions.

Describe the solution you'd like

If the description field is provided in OSS Directory, then that is the source of truth.

If not, then we auto-generate based on GitHub artifact(s):

  • If the project is instantiated via a GitHub org, it should pull the description from the GitHub org space.
  • If it's a single repo, then it can also be pulled from the repo description
  • If it's a list of repos, then we can auto-generate text describing the number of repos (eg, "This project reflects contributions made across X repos")

The description should also be included in the projects.sql mart and in the API.

Describe alternatives you've considered

Only using OSS Directory descriptions

ccerv1 avatar Apr 02 '24 13:04 ccerv1

Fair enough, probably makes sense to join it in a dbt model after importOssDirectory into the projects intermediate model

ryscheng avatar Apr 02 '24 13:04 ryscheng

Starting with enabling an optional description field in the project or collection files in oss-directory https://github.com/opensource-observer/oss-directory/pull/274

ryscheng avatar May 01 '24 00:05 ryscheng

I think the cloudquery plugin needs to be updated as well. I wonder if we can just have the cloudquery plugin use the JSON schema directly, rather than duck type it

ryscheng avatar May 01 '24 00:05 ryscheng

importOssDirectory from cloudquery grabs dsecription here https://github.com/opensource-observer/oso/pull/1360/files

ryscheng avatar May 03 '24 16:05 ryscheng

Following work in is to script a PR into oss-directtory

ryscheng avatar May 21 '24 18:05 ryscheng

We've gotten contributions from growthepie and RF4 so far. Maybe we just want a transform that will look for empty Project descriptions and query GitHub for found orgs

ryscheng avatar Jun 12 '24 19:06 ryscheng