Skip to content

Commit

Permalink
docs: 🎨 Typos and formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
davidgasquez committed Oct 31, 2024
1 parent 71b25f4 commit c0b3bb9
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,36 @@
# Filecoin Storage Providers Market Dashboard

## Status

At least of 2024-10-30, this dasbhoard is a scrappy work-in-progress to help spur discussion at [FDS-5 Bangkok](https://www.fildev.io/FDS-5) and shouldn't be viewed as canonical. It is being worked on actively by members of the "[PMF Targets Working Group](https://protocollabs.notion.site/Filecoin-PMF-Targets-Working-Group-111837df73d480b6a3a9e5bfd73063de?pvs=4)".

## Purpose

The purpose of this dashboard currently is to help fascilitate the market between onramps/aggregators and Storage Providers (SPs) so onramps/aggregators can find SPs to use and SPs can understand how they are being evaluated. This is being done by by exposing SP performance against the service classes with their supporting SLOs as defined in [filecoin-project/service-classes](https://github.com/filecoin-project/service-classes).

## Dasbhaord URL
## Dashboard URL

https://filecoin-project.github.io/filecoin-storage-providers-market/

> In future, this may house under a different domain.
## Contributing

If you want to help with data presentation, layout, etc. please see [implementation details](#implementation-details) below and open a PR.

Discussion and improvement proposals around service classes, SLOs, SLIs, and their defitions should occur in [filecoin-project/service-classes](https://github.com/filecoin-project/service-classes).

# Implementation Details
This is an [Observable Framework](https://observablehq.com/framework) app. Ensure you have the corresponding dependencies installed with:
## Implementation Details

```
This is an [Observable Framework](https://observablehq.com/framework) app. You'll need to install the [DuckDB CLI](https://duckdb.org/docs/installation/) and then run:

```bash
npm install
```

To start the local preview server, run:

```
```bash
npm run dev
```

Expand Down
7 changes: 5 additions & 2 deletions src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
- Check the [code](https://github.com/filecoin-project/filecoin-storage-providers-market).

## Status
TODO: fill this in about where we're currently at on 2024-10-30. I'll just pull from theh README.

This dasbhoard is a scrappy work-in-progress to help spur discussion at [FDS-5 Bangkok](https://www.fildev.io/FDS-5) and shouldn't be viewed as canonical. It is being worked on actively by members of the "[PMF Targets Working Group](https://protocollabs.notion.site/Filecoin-PMF-Targets-Working-Group-111837df73d480b6a3a9e5bfd73063de?pvs=4)".

```js
const daily_metrics = FileAttachment("data/daily_metrics.csv").csv({typed: true});
Expand Down Expand Up @@ -34,9 +35,11 @@ function createAnchorId(str) {
```

## Network-Wide Metrics

This is an aggregate view looking at all Storage Providers on the network.

### SP Activity

<div class="grid grid-cols-3">

<div class="card">
Expand Down Expand Up @@ -107,6 +110,7 @@ This is an aggregate view looking at all Storage Providers on the network.
</div>

### Service Class Conformance

<div class="grid grid-cols-2">
<div class="card">

Expand Down Expand Up @@ -176,7 +180,6 @@ This is an aggregate view looking at all Storage Providers on the network.

The table below lists metrics for Filecoin Storage Providers.


```js
const storage_providers = FileAttachment("data/storage_providers.csv").csv({typed: true});
```
Expand Down

0 comments on commit c0b3bb9

Please sign in to comment.