Skip to content

Latest commit

 

History

History
438 lines (305 loc) · 14.6 KB

README.md

File metadata and controls

438 lines (305 loc) · 14.6 KB
Raw

Ecosystem Dashboard

A dashboard for monitoring the ecosystem around an open source project.

Features

Organizations

Monitor activity across multiple organizations, both internal to your project and from external collaborators as well. For the IPFS project that means monitoring activity internal orgs from:

and collaborator organizations such as:

Collaborators

Collaborators are a key feature of the ecosystem dashboard, many large open source projects have more incoming issues and pull requests than they can possibly handle and so being able to visualize and prioritise activity by people from organizations that have an existing relationship with the project is essential to keeping those collaborations running smoothly.

You can highlight any github organization as a collaborator and then any activity by members of that organization will be added to the various collaborator dashboard views. The public activity within collaborator organizations will also be monitored for discovering new contributors, package usage and searching for relevant issues and pull requests.

Stats Overview

A high level overview of recent community metrics across all internal organizations, compared to the previous period.

Filterable by date range and internal organization.

Issues + PRs

Issues + PRs shows all issues and pull requests that have been opened by everyone (excluding bots), by default filtered to the last 30 days.

It's helpful to give an overview of all new issues and pull requests across all internal organizations for triage.

Issues and pull requests opened by Collaborators and Core contributors are highlighted.

It also includes a graph of how many new issues and pull requests were opened each day over the past month.

The most active contributors are also shown on the right sidebar.

This view is also filterable by the standard set of issue and pull request filters:

  • Author
  • State (open/closed)
  • Type (issue/pull request)
  • Repository
  • Org (internal github organizations)
  • Language (repository programming language)
  • Label
  • No Core Contributors response
  • Uncommented
  • No milestone
  • Unlabelled
  • Exclude core contributors
  • Date range
  • Sort (newest, oldest, recently updated, least recently updated)

Slow Responses

The Slow Responses page shows every internal issue and pull request that has not had a response from a core contributor within a reasonable time frame, which by default is 48 hours, over the past 7 days (plus the slow response window, so last 9 days by default).

It is helpful to give a view of all the issues and pull requests that have not been triaged by a core team member yet. Note that this does not mean all issues are expected to be fixed within 48 hours, but should have at least received some kind of response such as a comment, review or label.

It also shows a graph of the number of slow responses vs the number of new issues and pull requests for the week and a graph of the average response time per week over the past year.

Issues and pull requests opened by Collaborators are highlighted.

Issues and pull requests opened by core contributors are not included in this view.

The most active contributors and collaborators with slow responses are also shown on the right sidebar.

This view is also filterable by the standard set of issue and pull request filters:

  • Author
  • State (open/closed)
  • Type (issue/pull request)
  • Repository
  • Org (internal github organizations)
  • Language (repository programming language)
  • Label
  • Uncommented
  • No milestone
  • Unlabelled
  • Date range
  • Sort (newest, oldest, recently updated, least recently updated)

Internal Repositories

Internal Repositories gives a filterable view of all active repositories across all your internal organizations.

It shows highlevel information such as:

  • name
  • description
  • organization
  • last pushed date and time
  • repo size
  • number of dependencies

Repositories are also filterable by:

  • Organization
  • Main language
  • Source (not forked)
  • Forks
  • Active (not archived)
  • Archived

Collab Repositories

Collab Repositories gives a filterable view of all active repositories across all your collaborators organizations.

It shows highlevel information such as:

  • name
  • description
  • organization
  • last pushed date and time
  • repo size
  • number of dependencies

Repositories are also filterable by:

  • Organization
  • Main language
  • Source (not forked)
  • Forks
  • Active (not archived)
  • Archived

Community Repositories

Community Repositories gives a filterable view of all repositories that depend on an internal package and don't belong to a collaborator.

It shows highlevel information such as:

  • name
  • description
  • organization
  • last pushed date and time
  • repo size
  • number of dependencies

Repositories are also filterable by:

  • Organization
  • Main language
  • Source (not forked)
  • Forks
  • Active (not archived)
  • Archived

Events

The Events view is a list of all types of public github activities across all internal organizations, including:

  • Issue Comments
  • Pushes
  • Stars
  • Pull Requests
  • Review Comments
  • Issues
  • Branches created
  • Forks
  • Branches delete
  • Releases
  • Members added
  • Commit Comments
  • Repositories Open Sourced
  • Wiki updates

Events are also filterable by:

  • Organization
  • Repository
  • User
  • Type

Collabs Events

The Collabs Events view is a list of all types of public github activities across all collaborator organizations, including:

  • Issue Comments
  • Pushes
  • Stars
  • Pull Requests
  • Review Comments
  • Issues
  • Branches created
  • Forks
  • Branches delete
  • Releases
  • Members added
  • Commit Comments
  • Repositories Open Sourced
  • Wiki updates

Events are also filterable by:

  • Organization
  • Repository
  • User
  • Type

Packages

The Packages view is a list of all internal packages that have been published from internal repositories.

For each package it shows:

  • name
  • platform (package manager)
  • description
  • latest release number
  • Dependent collab repositories
  • org icon

It also has a basic package search function.

Packages are filterable by:

  • Organization
  • Platform (package manager)

Collabs Packages

The Collabs Packages view is a list of all packages owned by collaborator that have been published from collaborator repositories.

For each package it shows:

  • name
  • platform (package manager)
  • description
  • latest release number
  • Dependent collab repositories
  • org icon

Community Packages

The Packages view is a list of all packages found on a package registry (npmjs.org, crates.io etc) that depend on an internal package and don't belong to a collaborator.

For each package it shows:

  • name
  • platform (package manager)
  • description
  • latest release number
  • Dependent collab repositories
  • owner icon

Data model

The core data model of the dashboard is organized around a number of key entities, these can be sliced and diced to produce various dashboards, reports and other useful tools for investigating the ecosystem around an open source project.

Organizations

The dashboard is configured primarily around one or more github organizations that host the main open source project. For example, IPFS and related projects are hosted in a number of github orgs: IPFS, IPFS Shipyard and others. In general the internal organizations will be configured in initial setup and won't change regularly.

These organizations are called "Internal Organizations" in the dashboard schema, where internal is true. In code they can be loaded with the internal scope, for example: Organization.internal.all.

Collaborator organizations are the primary way of configuring contributors and projects that are closely related to the primary open source project.

Collaborator organizations are stored in the database with collaborator set to true. In code they can be loaded with the collaborator scope, for example: Organization.collaborator.all.

It's expected that new collaborator orgs will be added on a regular basis, and possibly even having some removed.

Repositories

Organizations have many repositories, the dashboard will attempt to download all public repositories for each org and them monitor them for new activity and updates.

Repositories that belong to internal organizations can be found with the internal scope: Repository.internal.all

Repositories that belong to collaborator organizations can be found with the collaborator scope: Repository.collaborator.all

Repositories that belong don't belong to either collaborators or internal organizations can be found with the community scope: Repository.community.all

Events

TODO

Issues

TODO

Core Contributors and Bots

TODO

Packages, Versions and Dependencies

TODO

Manifests and Repository Dependencies

TODO

Setup instructions

Want to hack on the website? Awesome!

New to Ruby? No worries! You can follow these instructions to install a local server.

Installing a Local Server

If you're on a Debian-based distro, you'll need some dependencies:

sudo apt install build-essential cmake pkg-config nodejs

First things first, you'll need to install Ruby 3.3.6. I recommend using the excellent rbenv, and ruby-build.

rbenv install 3.3.6
rbenv global 3.3.6

Next, you'll need to make sure that you have PostgreSQL installed. This can be done easily on OSX using Homebrew or by using http://postgresapp.com. Please see these further instructions for installing Postgres via Homebrew.

brew install postgres

On Debian-based Linux distributions you can use apt-get to install Postgres:

sudo apt install postgresql postgresql-contrib libpq-dev

On Windows, you can use the Chocolatey package manager to install Postgres:

choco install postgresql

Clone this repository:

git clone [email protected]:ipfs-shipyard/ecosystem-dashboard.git

Now, let's install the gems from the Gemfile ("Gems" are synonymous with libraries in other languages).

gem install bundler && rbenv rehash
bundle install

Once all the gems are installed, we'll need to create the databases and tables. Rails makes this easy through the use of "Rake" tasks.

bundle exec rake db:create:all
bundle exec rake db:migrate

Almost there! Now all we have to do is start up the Rails server and point our browser to http://localhost:3000

bundle exec rails s

Deployment

TODO

Cron

To keep all data fresh, regular background tasks are provided that can be ran on a regular basis to find and update issues, repositories and packages.

Suggested regular background rake tasks:

Command Frequency
bundle exec rake issues:sync_recent Every 10 minutes
bundle exec rake search:run_all Every 10 minutes
bundle exec rake issues:sync_collabs Hourly
bundle exec rake packages:sync Hourly
bundle exec rake repositories:sync Hourly
bundle exec rake issues:sync_daily Daily
bundle exec rake packages:find_missing_package_repos Daily
bundle exec rake packages:find_missing_npm_packages Daily
bundle exec rake packages:find_dependent_github_repos Daily
bundle exec rake packages:sync_internal Daily
bundle exec rake repositories:discover_from_search_results Daily
bundle exec rake repositories:recalculate_scores Daily

Configuring organizations

TODO

Access the console with $ bundle exec rails console then you can create organizations with the following code replace GITHUB_ORG_NAME with your internal organization github name:

org = Organization.create(name: GITHUB_ORG_NAME, internal: true)
org.import

Configuring collabs

Access the console with $ bundle exec rails console then you can create collaborator organizations with the following code replace GITHUB_ORG_NAME with the github name of the collaborator:

org = Organization.create(name: GITHUB_ORG_NAME, collaborator: true)
org.import

Configuring core contributors

After creating all of your internal organizations, access the console with $ bundle exec rails console and then run the following code to automatically detect all the core contributors in those organizations:

Organization.internal.each(&:guess_core_contributors)

Configuring bots

After creating all of your internal organizations, access the console with $ bundle exec rails console and then run the following code to automatically detect all the bots that contribute in those organizations:

Organization.internal.each(&:guess_bots)

License

Copyright (c) Protocol Labs, Inc.

This package is dual-licensed under Apache 2.0 and MIT terms: