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

Feature: feedback - repo page charts should be embeddable #3860

Open
4 tasks done
jpmcb opened this issue Aug 5, 2024 · 3 comments
Open
4 tasks done

Feature: feedback - repo page charts should be embeddable #3860

jpmcb opened this issue Aug 5, 2024 · 3 comments
Assignees
Labels
core team work Work that the OpenSauced core team takes on 💡 feature

Comments

@jpmcb
Copy link
Member

jpmcb commented Aug 5, 2024

Suggested solution

Lots of feedback we've gotten in the past is that charts should be embeddable. Our main use case for this we'll look at are contributors in the ublue-os org. There are 2 main scenarios we should target with this:

  • embed directly in markdown: lots of projects love to have these visualizations right in their GitHub readmes. Ideally, these should be able to be dropped into markdown somehow and render (even if they're static images that update once a day or so, that'd still be ideal)

  • embed directly in sites: we've gotten feedback that people want to be able to drop these charts directly in their project websites.

    • Use case: Bazzite also has a project site that we've gotten signal would use our graphs directly in the site to show potential users or contributors that the project is "alive, well, and maintained" Screenshot 2024-08-05 at 5 03 06 PM

  • Big stretch goal: render in Slack or other third party electron based applications. There's lots of sharing and screen-shotting that happens on Slack: that's hard to capture on our end and we'd love the ability to render in these third party applications and redirect the user experience back to OpenSauced.
Copy link
Contributor

github-actions bot commented Aug 5, 2024

Thanks for the issue, our team will look into it as soon as possible! If you would like to work on this issue, please wait for us to decide if it's ready. The issue will be ready to work on once we remove the "needs triage" label.

To claim an issue that does not have the "needs triage" label, please leave a comment that says ".take". If you have any questions, please comment on this issue.

For full info on how to contribute, please check out our contributors guide.

@jpmcb jpmcb changed the title Feature: repo page charts should be embeddable Feature: feedback - repo page charts should be embeddable Aug 5, 2024
@nickytonline nickytonline added the core team work Work that the OpenSauced core team takes on label Aug 7, 2024
@nickytonline
Copy link
Member

nickytonline commented Aug 7, 2024

I had a chat with @brandonroberts about this yesterday. We're going to pair on it most likely.

The TLDR; of the POC

  • Create a Netlify function that uses Playwright
  • Navigate via playwright to the page in question and use a selector that we'll add to find the graph.
  • Wait until the data is rendered client-side
  • Take a snapshot of that graph via Playwright
  • Persist to Netlify Blob for quicker access on subsequent requests for sharing the image but cache for x amount of time

The function with the given parameters, e.g. /snapshot/denoland/deno?graph=lottery will be the share URL.

CleanShot 2024-08-07 at 10 16 15

@nickytonline
Copy link
Member

I think I tried some of the dependencies @colbyfayock mentions in his latest video, https://www.youtube.com/watch?v=kOdIzhPfLuo, when I did a similar POC last year, but just popping it here as a reference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core team work Work that the OpenSauced core team takes on 💡 feature
Projects
None yet
Development

No branches or pull requests

3 participants