[Design] Design a Reports Page

[eryc-cc]

Ideal:

• Facilitate tweeting: people can share that data on Twitter really easily, and in a pretty way (OpenSauced branded)
• Export CSVs

What we want to be able to do:

• Tell them things like: "10 projects doubled their effective contributions because of Hacktoberfest"

To scope:

• [x] #153
• [x] #154

[eryc-cc]

@bdougie @chadstewart

What kind of data are we looking to show on reports? Is it granular data? Is it an expanded version of the Dashboard?

Should we wait for DigitalOcean to tell us what they need to be reporting, so we can implement what they need?

[bdougie]

We will need to design for two options. The first is

First option CSV

• List all contributions in the last 30 days based on x users in y repos. This would be similar to the gitsense list, but in CSV form.

Second option infographic (pdfs and tweets).

This will more likely be shareable infographics similar to the octoverse. For this we will provide our opinions and only 1 or 2 options.

1. Contributor growth over time (up or down)
2. New contributors over time
3. Contributions from org members vs outside contributors

side note: I grabbed the url oss.fyi to potentially make that the short URL for the shareable infographics.

[bdougie]

Ok, here is my thought. We can leverage the above to provide an SQL builder similar to Supabase (pictured below).

The thought is that we can let you generate your own CSVs, but provide some templates to get started. Let me know your thoughts @pixelsbyeryc

This might mean the info graphics are one-off and non-editable queries, but folks could potentially start there.

supabase sql editor

supabase sql templates

[eryc-cc]

@bdougie I have some other questions:

1. How customizable do we want to make this data?
2. And do we want to provide a CSV with everything that we have?

In terms of the UI and the flow, how should we approach it?

• Is this going to be an actionable page, eg: show 2 big card buttons for each option.
• Or is it going to be an in-depth data preview + actions to export? Eg: showing a table with the data + a button to export.

[bdougie]

1. We won't make this customizable to start, we just need to present the SQL based on the opinionated reports we will provide. Perhaps we don't show the SQL at first or hide it behind a "show the SQL" feature.
2. Yes, but it will need to be limited. There is a natural timeout in SQL, so the limit would be 10k rows (or similar). We should probably encourage folks to narrow thee repos or data in a tool tip or warning.

• I think we should go the simpler option to begin with. Large cards with descriptions is ideal. Export to csv buttons after the selection and possibly.
• Probably want to keep the complexity simple. We don't need to show data in app, instead allow the user to download instead. Presenting the data in app is something we can tackle later down the road.

Hopefully this is helpful and not more confusing.

[eryc-cc]

@bdougie from Slack:

to start, we want contributions grouped by contributor.

Question

Page Flow

There is a natural timeout in SQL, so the limit would be 10k rows (or similar). We should probably encourage folks to narrow thee repos or data in a tool tip or warning.

I’m thinking about the flow of the page… Should it be:

1. User selects the repos they want to see data from
2. Gets warning if it’s over 10k rows *
3. Button comes up to download PDF/CSV

How are we going to generate reports (in the backend)?

Is it on-demand, like PayPal does (screenshot below)?

In this case, we would need to store the PDF/CSV they requested, and show a list of previous exports in the UI, right?

And it’d be best to indicate whether they can generate reports or not, based on their rate limit (eg: they just clicked to export, so they can’t generate new reports until their current report has done processing)

[bdougie]

I just double checked and it's 1000 rows not 10k limitation. Just an fyi. It seemed high so I double checked.

https://www.w3schools.com/sql/sql_top.asp

[0-vortex]

1000 is also supabase limit atm

[bdougie]

Quick follow up. I spoke with Terrence today and he mentioned that we will receive a raw postgres URL that we can pass to SQL queries. Basically this mean that we can generate reports on just about anything we have data for. So we are in moving in the right direction by eventually providing a custom SQL editor.

I think we will provide this feature to only paying customers. Custom SQL scripts will be a higher paid feature, mainly because we will provide them dedicated indexing (every minute, but we will see when we get there).

[eryc-cc]

@bdougie @chadstewart

I have 3 screens for the reports, let me know if I need any others.

Here's the thought process:

• Screen 1: The user will be able to select up to X repos to get a CSV report from the latest 30 day contributions.
• Screen 2: We'll have pre-selected reports (like the #58) that they'll be able to select from.
• Screen 3: It's just a history of all their report requests, that they'll be able to download later on.

Screen 1

Screen 2

Screen 3

[bdougie]

I think this is a good first pass. Here are my initial thoughts.

1. It should state "Contributions" instead of "Activities"
2. We don't need the "Pre-defined." Instead we can name this "Contributor Insights." Reports are inferred.
3. We can include the opinionated filters as options for reports.

For these "Contributor insights," reminder this is what we are providing.

• Contributor growth over time (up or down)
• New contributors over time
• Contributions from org members vs outside contributors

[eryc-cc]

For these "Contributor insights," reminder this is what we are providing.

• Contributor growth over time (up or down)
• New contributors over time
• Contributions from org members vs outside contributors

I created new issues... We need to scope the information we want to show on our PDF Reports, and then design them:

• 153

• 154

1. What options should we give them?
2. When we say “contributor growth over time”, how much time are we scoping? Last 30 days? Last 90 days?
3. And should we give them a datepicker to choose from?
4. Should each of these options be their own page, with more options to filter? Eg: I want contributor growth from Jan 2022 to Aug 2022 from repos X, Y, and Z?

[bdougie]

When we say “contributor growth over time”, how much time are we scoping? Last 30 days? Last 90 days?

I think we should limit all results to 30days or MTD (month to date starting with the 1st of the month)

For now (because scope) no customer date picker or further options.

[eryc-cc]

Okay @bdougie I'll get it polished for tomorrow. 🙏

[eryc-cc]

According to a conversation me and @bdougie had, we're going to ship 2 versions of the Reports Page:

1. For Digital Ocean (during the Hacktoberfest event)
2. For the Insiders group

Hacktobefest Version

• Can only filter (by the pre-defined opinionated filters we have)
• History will show below

Insiders Version

• Cannot use the pre-defined opinionated filters (because it would grab too many repos)
• User has to select which repos they want reports from
• History will be shown in another page (user can navigate through the left sidebar)