Git Product home page Git Product logo

pl-compass's Introduction

PL Compass project (Launchpad)

Check out the published site on https://pl-compass.on.fleek.co/

Problem statement

There are so many cool ideas and project happening at PL, but it is hard to navigate and understand what is happening where and what was already done/being in progress

Project statement

Improve discoverability and traceability of the projects developed, running and deprecated by people at Protocol Labs without the need for manual db management

Valuable projects would surface more easily, get more contributions, and we'd minimize the amount of energy "wasted" reinventing things in the web3 industry.

Plus:

  • More developers will create projects and apps using PL ecosystem if docs are easily to find / easily to read
  • You can view a collection of PL projects in a single place, and navigate to each of them easily. The index/list/collection should include their github stars, health, activity, etc..
  • You could also filter based on language, category or other -- e.g. more contributors & attention for projects

Key features

  • Internal focus → People in PL should be able to figure out what things are being developed right now and navigate to find the useful resources for them easily
  • Simple update → Databases with multiple source of input are hard to maintain, this process should be automated as much as possible
  • Simple discoverability → Representation of the information should be convenient for users to navigate through, finding relevant information through queries, labels or mind maps
  • Simple traceability → Figure out who was the person responsible for the project and what were all the contributors to it during its lifetime

Tool description

Simple website similar to https://ecosystem.filecoin.io/ for navigating across existing Tools → Github Projects → Consumer use-cases in Protocol Labs for better structure and love to the projects being created in PL and its community

Initial project idea brainstorming

Miro board

image

pl-compass's People

Contributors

sgtpooki avatar tkkonstantin avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

pl-compass's Issues

Miro backlog 1: Project stages proposal

Possible stages for Compass tool:

  1. Tools level (e.g. broad overview of available tools and respective maintainers in a single database with linked websites and nice label navigation) <-- already available, starting directly from the second point. Just requires indexing of existing projects
  2. Github project/implementations level (e.g. detailed view of projects, developed label and navigation system + crawler for automatic indexing of existing and new projects)
  3. Find projects using PL projects dependencies -> have an understanding of final users/consumers

Project stages readiness:

  1. MVP
    • Web UI for viewing and filtering resources
    • Database for storing metadata
    • Automating labelling of resources
    • Github crawler + Web-Spider
    • DB design for our use-case (object, label, social fingerprint, link)
  2. Next steps
    • Package manager crawler
    • Web on-page crawler
  3. Long-term plan
    • Abstraction layer crawler (identifies where to crawl/what to crawl)
    • Social network crawler

User Stories

We need to collect user stories so we can map out our feature plan:

  • As a PL employee, I want to be able to see all of the repositories I am responsible for
  • As a member of a PL team, I want to be able to see all of the repositories my team is responsible for
  • As a PL employee interested in a github repo, I want to be able to see who is the owner/DRI for that github repo.

Call with Andrew notes

Initial motivation:

  • response time to issue 30 days
  • ecosystem dashboard -> as a single source of tracking of all issues -> tracking stuff across the whole organization
  • tracking the response rate and having additional metrics on issues created

Next functionality

  1. Understanding how different projects work together
  2. Packages linking and tracking libraries
  3. Triaging issues of projects
  4. Understanding how people are using all this open-source stuff (coz no tracking code in open source stuff)
  5. Tracking the activity of projects using our libraries
  6. Automatic crawler through GitHub
  7. Tracking Hackathon submissions for quality of using our tech (tracking contributors as well)
  8. General issue triaging

Miro backlog 2: Useful resources

Similar projects or efforts:

2022-03-09 chat with Konstantine

Todo items

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.