From 2d8f0a19447a8781739c28bafa8f31cdbfa8e32f Mon Sep 17 00:00:00 2001 From: Carl Cervone <42869436+ccerv1@users.noreply.github.com> Date: Mon, 2 Dec 2024 06:38:09 -0500 Subject: [PATCH] docs: rf contribution pathways (#2554) * chore: update superchain data soruce * feat(docs): add retro funding contributing page * fix: broken link --- .../index.mdx | 2 +- .../blog/2024-07-16-oso-data-portal/index.md | 2 +- .../connect-data/dagster-config.mdx | 2 +- .../{impact-models.md => data-models.md} | 0 apps/docs/docs/contribute/index.mdx | 14 +++- apps/docs/docs/contribute/join-team.mdx | 4 +- apps/docs/docs/contribute/retrofunding.md | 71 ++++++++++++++++ apps/docs/docs/get-started/index.mdx | 2 +- .../docs/how-oso-works/impact-metrics/code.md | 2 +- .../impact-metrics/dependencies.md | 2 +- .../how-oso-works/impact-metrics/index.mdx | 2 +- .../how-oso-works/impact-metrics/onchain.md | 2 +- .../how-oso-works/impact-metrics/package.md | 2 +- apps/docs/docs/integrate/api.md | 2 +- apps/docs/docs/integrate/overview/index.mdx | 78 ++++++------------ apps/docs/docs/integrate/overview/op.png | Bin 0 -> 45116 bytes apps/docs/docs/integrate/python-notebooks.md | 2 +- apps/docs/docs/integrate/query-data.mdx | 2 +- 18 files changed, 125 insertions(+), 66 deletions(-) rename apps/docs/docs/contribute/{impact-models.md => data-models.md} (100%) create mode 100644 apps/docs/docs/contribute/retrofunding.md create mode 100644 apps/docs/docs/integrate/overview/op.png diff --git a/apps/docs/blog/2024-02-28-arbitrum-impact-pools/index.mdx b/apps/docs/blog/2024-02-28-arbitrum-impact-pools/index.mdx index 9c2a2a107..7537dca8d 100644 --- a/apps/docs/blog/2024-02-28-arbitrum-impact-pools/index.mdx +++ b/apps/docs/blog/2024-02-28-arbitrum-impact-pools/index.mdx @@ -29,7 +29,7 @@ First, our data platform is still in active development. We just recently connec Second, we are continuously iterating on our impact metrics. We hope the metrics included here illustrate what's possible to quickly identify trends among projects and relative performance levels. However, the metrics we chose should not be viewed as applicable to all projects or battle-tested against gamification. Similarly, the coefficients used to weight metrics in our impact pools are only intended to serve as starting points for further analysis. -If you have ideas for how to test and iterate on these types of impact metrics and pools, check out [our docs](https://docs.opensource.observer/docs/contribute/impact-models) and send us a note. +If you have ideas for how to test and iterate on these types of impact metrics and pools, check out [our docs](https://docs.opensource.observer/docs/contribute/data-models) and send us a note. ## How pools are constructed diff --git a/apps/docs/blog/2024-07-16-oso-data-portal/index.md b/apps/docs/blog/2024-07-16-oso-data-portal/index.md index 2fc212023..a8aef4f14 100644 --- a/apps/docs/blog/2024-07-16-oso-data-portal/index.md +++ b/apps/docs/blog/2024-07-16-oso-data-portal/index.md @@ -116,7 +116,7 @@ where passport_address = '0xd8da6bf26964af9d7eed9e03e53415d37aa96045' When you’ve developed a novel impact metrics or data model, we encourage you to -[contribute back to the OSO data pipeline](https://docs.opensource.observer/docs/contribute/impact-models), +[contribute back to the OSO data pipeline](https://docs.opensource.observer/docs/contribute/data-models), which is continuously deployed from our [open source repository](https://github.com/opensource-observer/oso/). diff --git a/apps/docs/docs/contribute/connect-data/dagster-config.mdx b/apps/docs/docs/contribute/connect-data/dagster-config.mdx index e5406103f..3b9c69ab7 100644 --- a/apps/docs/docs/contribute/connect-data/dagster-config.mdx +++ b/apps/docs/docs/contribute/connect-data/dagster-config.mdx @@ -98,4 +98,4 @@ from {{ source("ethereum", "transactions") }} - [**SQL Query Guide**](../../integrate/query-data.mdx): run queries against the data you just loaded - [**Connect OSO to 3rd Party tools**](../../integrate/3rd-party.mdx): explore your data using tools like Hex.tech, Tableau, and Metabase -- [**Write a dbt model**](../impact-models.md): contribute new impact and data models to our data pipeline +- [**Write a dbt model**](../data-models.md): contribute new impact and data models to our data pipeline diff --git a/apps/docs/docs/contribute/impact-models.md b/apps/docs/docs/contribute/data-models.md similarity index 100% rename from apps/docs/docs/contribute/impact-models.md rename to apps/docs/docs/contribute/data-models.md diff --git a/apps/docs/docs/contribute/index.mdx b/apps/docs/docs/contribute/index.mdx index 482bd03a7..f27be11e5 100644 --- a/apps/docs/docs/contribute/index.mdx +++ b/apps/docs/docs/contribute/index.mdx @@ -55,7 +55,7 @@ There are a variety of ways you can contribute to OSO. This doc features some of - Propose an Impact Data Model + Propose an Impact Data Model oso @@ -63,6 +63,18 @@ There are a variety of ways you can contribute to OSO. This doc features some of Submit a dbt data model for tracking open source impact metrics. Data Scientists, Analysts + + + Create Metrics for Retro Funding + + + oso + + + Help develop impact metrics for allocating retroactive funding to open source projects. + + Data Scientists, Analysts + Share Insights diff --git a/apps/docs/docs/contribute/join-team.mdx b/apps/docs/docs/contribute/join-team.mdx index ba424292d..7be7f7110 100644 --- a/apps/docs/docs/contribute/join-team.mdx +++ b/apps/docs/docs/contribute/join-team.mdx @@ -1,6 +1,6 @@ --- -title: Join the team -sidebar_position: 10 +title: Join the Team +sidebar_position: 8 ---