Skip to content

Commit 00ec066

Browse files
authored
docs: more reorganization of docs (#2643)
1 parent e93b28f commit 00ec066

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+92
-124
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,4 +212,4 @@ is released under Apache 2.0
212212
This repository does not contain data.
213213
Datasets may include material that may be subject to third party rights.
214214
For details on each dataset, see
215-
the [Data Overview](https://docs.opensource.observer/docs/integrate/overview/).
215+
the [Data Overview](https://docs.opensource.observer/docs/integrate/datasets/).

apps/docs/blog/2024-03-20-request-for-impact-metrics/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ If you'd like to get involved, here's what to do:
1717
1. Apply to [join the Data Collective](https://www.kariba.network/). It only takes a few minutes. We'll review, and reach out to schedule an onboarding call.
1818
2. Join our [Discord server](https://www.opensource.observer/discord) and say hello.
1919
3. Get inspiration from our Colab directory of [starter notebooks for impact metrics](https://drive.google.com/drive/folders/1I4exiLfZYgPwIGBEzuAMeGtJUhtS_DE7?usp=drive_link). We also have of them in our [Insights repo](https://github.com/opensource-observer/insights/tree/main/community/notebooks) if you prefer to run them locally.
20-
4. Consult [our docs](../../docs/) and especially our [impact metric spec](../../docs/guides/impact-metrics/) as you prepare your analysis.
20+
4. Consult [our docs](../../docs/) and especially our [impact metric spec](../../docs/references/impact-metrics/) as you prepare your analysis.
2121

2222
The rest of this post includes more details on the types of impact metrics we're interested in.
2323

@@ -62,7 +62,7 @@ _Metrics that attempt to differentiate onchain users based on behavior and trust
6262

6363
This is a hot topic right now, with a number of projects attempting to create reputation systems for onchain users. We're integrating with many of the leading projects and bringing the data they generate into the OSO data warehouse. From there, there are all sorts of directions you can take the analysis!
6464

65-
The **Onchain Activity** metric is a good starting point for new analysts. Have a look at our working definitions for [onchain users](../../docs/guides/impact-metrics/onchain) and help us create some better ones. The **Network Loyalty** is a spicy metric that will get even spicier as we add more networks to the OSO dataset!
65+
The **Onchain Activity** metric is a good starting point for new analysts. Have a look at our working definitions for [onchain users](../../docs/references/impact-metrics/onchain) and help us create some better ones. The **Network Loyalty** is a spicy metric that will get even spicier as we add more networks to the OSO dataset!
6666

6767
| Impact Metric | Description | Comments |
6868
| :--------------- | :---------------------------------------------------- | :----------------------------------------- |

apps/docs/blog/2024-06-29-impact-metrics-rf4-deep-dive/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ We're excited to see how this type of model evolves and is extended for future u
116116

117117
## Developing the impact metrics
118118

119-
The following design principles guide the development and evolution of [impact metrics](../../docs/guides/impact-metrics/#principles):
119+
The following design principles guide the development and evolution of [impact metrics](../../docs/references/impact-metrics/#principles):
120120

121121
- Verifiability: Metrics should be based on public data that can be independently verified. They should not rely on proprietary data sources or private APIs.
122122
- Reproducibility: Metrics should be easy to reproduce, simulate, and audit to ensure they are achieving the intended results. They should not have a "black box" element that makes them difficult to understand or replicate.

apps/docs/blog/2024-07-16-oso-data-portal/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ OSO Data Exchange on Google BigQuery.
1414
Here, we will publish every data set we have as live,
1515
up-to-date, and free to use datasets.
1616
In addition to sharing every model in the
17-
[OSO production data pipeline](https://docs.opensource.observer/docs/integrate/overview/#oso-production-data-pipeline),
17+
[OSO production data pipeline](../../docs/integrate/datasets#oso-production-data-pipeline),
1818
we are sharing source data for blocks/transactions/traces across
19-
[7 chains in the OP Superchain](https://docs.opensource.observer/docs/integrate/overview/#superchain-data)
19+
[7 chains in the OP Superchain](../../docs/integrate/datasets#optimism-data)
2020
(including Optimism, Base, Frax, Metal, Mode, PGN, Zora),
21-
[Gitcoin Data](https://docs.opensource.observer/docs/integrate/overview/#gitcoin-and-passport-data),
22-
and [OpenRank](https://docs.opensource.observer/docs/integrate/overview/#openrank-data).
21+
[Gitcoin Data](../../docs/integrate/datasets#gitcoin-and-passport-data),
22+
and [OpenRank](../../docs/integrate/datasets#openrank-data).
2323
This builds on the existing BigQuery public data ecosystem that includes
24-
[GitHub](https://docs.opensource.observer/docs/integrate/overview/#github-data),
25-
[Ethereum](https://docs.opensource.observer/docs/integrate/overview/#ethereum-data),
26-
[Farcaster](https://docs.opensource.observer/docs/integrate/overview/#farcaster-data),
27-
and [Lens](https://docs.opensource.observer/docs/integrate/overview/#lens-data) data.
24+
[GitHub](../../docs/integrate/datasets#github-data),
25+
[Ethereum](../../docs/integrate/datasets#ethereum-data),
26+
[Farcaster](../../docs/integrate/datasets#farcaster-data),
27+
and [Lens](../../docs/integrate/datasets#lens-data) data.
2828
To learn more, check out the data portal here:
2929

3030
<p style={{"text-align": "center"}}>

apps/docs/blog/2024-08-12-war-for-public-goods/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,4 +97,4 @@ Once again, there are valuable lessons from baseball that we can apply:
9797
- **Embrace Competing Implementations**: As mentioned earlier, there is no single standard calculation for WAR. Even though the data and methodologies are public, there’s vibrant debate about which method is best. In an industry as dynamic as crypto, this diversity of approaches is a strength, encouraging innovation and continuous improvement.
9898
- **Engage the Research Community**: WAR models are like catnip for data enthusiasts. They offer endless opportunities for simulation, experimentation, and visualization. By providing well-documented, easy-to-use datasets and stoking interest in the results from protocol leaders and governance teams, we can create a garden of catnip for researchers and data nerds.
9999

100-
At Open Source Observer, we want to build the equivalent of a sabermetrics for open source impact. If you have ideas for a WAR model, check out our existing library of [data](../../docs/integrate/overview) and [metrics](../../docs/guides/impact-metrics/), and come say hi on our [Discord](https://www.opensource.observer/discord).
100+
At Open Source Observer, we want to build the equivalent of a sabermetrics for open source impact. If you have ideas for a WAR model, check out our existing library of [data](../../docs/integrate/datasets) and [metrics](../../docs/references/impact-metrics/), and come say hi on our [Discord](https://www.opensource.observer/discord).

apps/docs/docs/contribute-data/bigquery/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Connect via BigQuery",
3-
"position": 1,
3+
"position": 2,
44
"link": {
55
"type": "doc",
66
"id": "index"

apps/docs/docs/contribute-data/bigquery/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ trivially easy to integrate any public dataset into
88
the OSO data pipeline, provided the dataset exists in
99
the US multi-region.
1010

11-
If the dataset needs to be replicated, see our guide on
11+
If you want OSO to host a copy of
12+
the dataset in the US multi-region,
13+
see our guide on
1214
[BigQuery Data Transfer Service](./replication.md).
1315

1416
## Make the data available in the US region

apps/docs/docs/contribute-data/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Dagster Quickstart
3-
sidebar_position: 2
3+
sidebar_position: 1
44
---
55

66
# Dagster quickstart

apps/docs/docs/contribute-models/challenges/2024-04-05-data-challenge-01.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Here’s what you need to do to participate in this (and future) data challenges
7272

7373
1. Join the [Kariba Data Collective](https://www.kariba.network/). Participation is open to anyone in the data collective (free to join, but we review applications).
7474
2. Join our Discord and receive a **_data-collective_** role; ask questions and share code snippets in the **_#data-challenges_** channel.
75-
3. Bookmark [our docs and tutorials](../../guides/impact-metrics/) for creating impact metrics. Also make sure to browse our [Colab Notebooks](https://drive.google.com/drive/folders/1mzqrSToxPaWhsoGOR-UVldIsaX1gqP0F) for examples and inspiration.
75+
3. Bookmark [our docs and tutorials](../../references/impact-metrics/) for creating impact metrics. Also make sure to browse our [Colab Notebooks](https://drive.google.com/drive/folders/1mzqrSToxPaWhsoGOR-UVldIsaX1gqP0F) for examples and inspiration.
7676
4. Submit your impact metric(s) by opening an issue on our Insight repo [here](https://github.com/opensource-observer/insights/issues/new/choose).
7777

7878
Every impact metric submission should include:

apps/docs/docs/contribute-models/challenges/2024-07-30-openrank.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ We've queued up a few ideas to get you started:
3434

3535
- **Protocol Rank**. This [notebook](https://github.com/opensource-observer/insights/blob/main/community/data_challenges/openrank/OpenRank_ProtocolRank.ipynb) uses the same logic as the Repo Rank notebook, but narrows the curation space to only include projects that have deployed contracts on an Ethereum Layer 2.
3636

37-
- **Gitcoin Project Rank**. This [notebook](https://github.com/opensource-observer/insights/blob/main/community/data_challenges/openrank/OpenRank_GitcoinProjectRank.ipynb) builds on top of our recently-added [Gitcoin Grants dataset](https://docs.opensource.observer/docs/integrate/overview/#gitcoin-and-passport-data), which includes a history of every peer-to-peer donation on the Gitcoin platform. It also taps the Farcaster dataset to identify usernames associated with donors.
37+
- **Gitcoin Project Rank**. This [notebook](https://github.com/opensource-observer/insights/blob/main/community/data_challenges/openrank/OpenRank_GitcoinProjectRank.ipynb) builds on top of our recently-added [Gitcoin Grants dataset](../../integrate/datasets/index.mdx#gitcoin-and-passport-data), which includes a history of every peer-to-peer donation on the Gitcoin platform. It also taps the Farcaster dataset to identify usernames associated with donors.
3838

3939
### Requirements
4040

0 commit comments

Comments
 (0)