diff --git a/README.md b/README.md index 5a666edd0..21fcc0003 100644 --- a/README.md +++ b/README.md @@ -201,7 +201,7 @@ $ dbt run --select {name_of_the_model} For setup and common operations for each subproject, navigate into the respective directory and check out the `README.md`. -You can also find some operations guides on our [documentation](https://docs.opensource.observer/docs/how-oso-works/ops/). +You can also find some operations guides on our [documentation](https://docs.opensource.observer/docs/guides/ops/). ## License diff --git a/apps/docs/blog/2024-01-31-arb-ecosystem-analysis/index.mdx b/apps/docs/blog/2024-01-31-arb-ecosystem-analysis/index.mdx index e0015a7b9..1fd80828b 100644 --- a/apps/docs/blog/2024-01-31-arb-ecosystem-analysis/index.mdx +++ b/apps/docs/blog/2024-01-31-arb-ecosystem-analysis/index.mdx @@ -24,7 +24,7 @@ For those interested in a deeper dive, the Python notebooks used for data proces In this report, we explore 345 OSS projects that are integral to the Arbitrum ecosystem. Their contributions range from open source code development to deploying smart contracts on Arbitrum One, thereby facilitating millions of transactions and generating significant sequencer fees. -As there is no centralized repository of all the projects and contributors in a decentralized network economy like Arbitrum, we developed a unique methodology to compile an initial directory of these entities. We invite your contributions to enhance this directory; please visit [here](https://github.com/opensource-observer/oss-directory) to submit a PR or [here](https://docs.opensource.observer/docs/contribute/) to learn more about how to contribute data about projects and their code artifacts. +As there is no centralized repository of all the projects and contributors in a decentralized network economy like Arbitrum, we developed a unique methodology to compile an initial directory of these entities. We invite your contributions to enhance this directory; please visit [here](https://github.com/opensource-observer/oss-directory) to submit a PR or [here](../../docs/projects/) to learn more about how to contribute data about projects and their code artifacts. ### Methodology for project identification 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 7537dca8d..204db36b0 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 @@ -19,7 +19,7 @@ The real value, however, lies in combining simple metrics in novel ways to filte -As described in [our previous post](https://docs.opensource.observer/blog/arb-ecosystem-analysis#methodology-for-project-identification), these projects were sourced primarily from the most recent [“Electric Capital Crypto Ecosystems Mapping”](https://github.com/electric-capital/crypto-ecosystems), from Dune Analytics, and from Plurality Labs partners including [Karma GAP](https://gap.karmahq.xyz/arbitrum/) and [OpenBlock Labs](https://www.openblocklabs.com/app/arbitrum/grantees). We invite your contributions to enhance this directory; please visit [here](https://github.com/opensource-observer/oss-directory) to submit a PR or [here](https://docs.opensource.observer/docs/contribute/) to learn more about how to contribute data about projects and their code artifacts. +As described in [our previous post](https://docs.opensource.observer/blog/arb-ecosystem-analysis#methodology-for-project-identification), these projects were sourced primarily from the most recent [“Electric Capital Crypto Ecosystems Mapping”](https://github.com/electric-capital/crypto-ecosystems), from Dune Analytics, and from Plurality Labs partners including [Karma GAP](https://gap.karmahq.xyz/arbitrum/) and [OpenBlock Labs](https://www.openblocklabs.com/app/arbitrum/grantees). We invite your contributions to enhance this directory; please visit [here](https://github.com/opensource-observer/oss-directory) to submit a PR or [here](../../docs/projects/) to learn more about how to contribute data about projects and their code artifacts. ## A word of caution @@ -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/data-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](../../docs/contribute-models/data-models) and send us a note. ## How pools are constructed diff --git a/apps/docs/blog/2024-03-20-request-for-impact-metrics/index.md b/apps/docs/blog/2024-03-20-request-for-impact-metrics/index.md index 9770c24db..e836c2ef3 100644 --- a/apps/docs/blog/2024-03-20-request-for-impact-metrics/index.md +++ b/apps/docs/blog/2024-03-20-request-for-impact-metrics/index.md @@ -17,7 +17,7 @@ If you'd like to get involved, here's what to do: 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. 2. Join our [Discord server](https://www.opensource.observer/discord) and say hello. 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. -4. Consult [our docs](https://docs.opensource.observer/docs/) and especially our [impact metric spec](https://docs.opensource.observer/docs/how-oso-works/impact-metrics/) as you prepare your analysis. +4. Consult [our docs](../../docs/) and especially our [impact metric spec](../../docs/guides/impact-metrics/) as you prepare your analysis. The rest of this post includes more details on the types of impact metrics we're interested in. @@ -62,7 +62,7 @@ _Metrics that attempt to differentiate onchain users based on behavior and trust 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! -The **Onchain Activity** metric is a good starting point for new analysts. Have a look at our working definitions for [onchain users](https://docs.opensource.observer/docs/how-oso-works/impact-metrics/onchain_users) 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! +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! | Impact Metric | Description | Comments | | :--------------- | :---------------------------------------------------- | :----------------------------------------- | diff --git a/apps/docs/blog/2024-06-29-impact-metrics-rf4-deep-dive/index.md b/apps/docs/blog/2024-06-29-impact-metrics-rf4-deep-dive/index.md index 5fbb6a6d5..6413b390a 100644 --- a/apps/docs/blog/2024-06-29-impact-metrics-rf4-deep-dive/index.md +++ b/apps/docs/blog/2024-06-29-impact-metrics-rf4-deep-dive/index.md @@ -72,7 +72,7 @@ Another foundational building block is a registry we maintain called [OSS Direct Every project that applied for Retro Funding (and met eligibility criteria) is included in [OSS Directory](https://github.com/opensource-observer/oss-directory). -As described in [our docs](https://docs.opensource.observer/docs/how-oso-works/oss-directory/artifact), OSS Directory has one strict rule: an artifact can only belong to one project at a time. This means that a blockchain address or a repo cannot be included in multiple projects. +As described in [our docs](../../docs/guides/oss-directory/artifact), OSS Directory has one strict rule: an artifact can only belong to one project at a time. This means that a blockchain address or a repo cannot be included in multiple projects. ![image](./oss-directory.png) @@ -116,7 +116,7 @@ We're excited to see how this type of model evolves and is extended for future u ## Developing the impact metrics -The following design principles guide the development and evolution of [impact metrics](https://docs.opensource.observer/docs/how-oso-works/impact-metrics/#principles): +The following design principles guide the development and evolution of [impact metrics](../../docs/guides/impact-metrics/#principles): - Verifiability: Metrics should be based on public data that can be independently verified. They should not rely on proprietary data sources or private APIs. - 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. diff --git a/apps/docs/blog/2024-07-15-impact-of-retro-funding/index.md b/apps/docs/blog/2024-07-15-impact-of-retro-funding/index.md index b417c1244..cb4a7512b 100644 --- a/apps/docs/blog/2024-07-15-impact-of-retro-funding/index.md +++ b/apps/docs/blog/2024-07-15-impact-of-retro-funding/index.md @@ -25,7 +25,7 @@ Remember: _correlation is not causation_. While there are numerous signs of posi ## Cohort Analysis -At the time of writing, there are 23 [collections](https://docs.opensource.observer/docs/how-oso-works/oss-directory/collection) in the [OSS Directory](https://github.com/opensource-observer/oss-directory/tree/main/data/collections) we maintain, with a total of 1506 distinct projects with relevant activity in the last 6 months. Of these, 546 have applied for or received Retro Funding at some point. +At the time of writing, there are 23 [collections](../../docs/guides/oss-directory/collection) in the [OSS Directory](https://github.com/opensource-observer/oss-directory/tree/main/data/collections) we maintain, with a total of 1506 distinct projects with relevant activity in the last 6 months. Of these, 546 have applied for or received Retro Funding at some point. The breakdown of RF projects by cohort is as follows: 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 a8aef4f14..79249ac7c 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/data-models), +[contribute back to the OSO data pipeline](../../docs/contribute-models/data-models), which is continuously deployed from our [open source repository](https://github.com/opensource-observer/oso/). diff --git a/apps/docs/blog/2024-08-12-war-for-public-goods/index.md b/apps/docs/blog/2024-08-12-war-for-public-goods/index.md index a67e7853b..f4db09d59 100644 --- a/apps/docs/blog/2024-08-12-war-for-public-goods/index.md +++ b/apps/docs/blog/2024-08-12-war-for-public-goods/index.md @@ -97,4 +97,4 @@ Once again, there are valuable lessons from baseball that we can apply: - **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. - **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. -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](https://docs.opensource.observer/docs/integrate/overview/) and [metrics](https://docs.opensource.observer/docs/how-oso-works/impact-metrics/), and come say hi on our [Discord](https://opensource.observer/discord). +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). diff --git a/apps/docs/docs/how-oso-works/_category_.json b/apps/docs/docs/contribute-data/_category_.json similarity index 68% rename from apps/docs/docs/how-oso-works/_category_.json rename to apps/docs/docs/contribute-data/_category_.json index 3292e312d..1a3212147 100644 --- a/apps/docs/docs/how-oso-works/_category_.json +++ b/apps/docs/docs/contribute-data/_category_.json @@ -1,5 +1,5 @@ { - "label": "Learn How OSO Works", + "label": "Contribute Data", "position": 5, "link": { "type": "doc", diff --git a/apps/docs/docs/contribute/connect-data/airbyte.md b/apps/docs/docs/contribute-data/airbyte.md similarity index 100% rename from apps/docs/docs/contribute/connect-data/airbyte.md rename to apps/docs/docs/contribute-data/airbyte.md diff --git a/apps/docs/docs/contribute/connect-data/api.md b/apps/docs/docs/contribute-data/api.md similarity index 100% rename from apps/docs/docs/contribute/connect-data/api.md rename to apps/docs/docs/contribute-data/api.md diff --git a/apps/docs/docs/contribute/connect-data/bigquery/_category_.json b/apps/docs/docs/contribute-data/bigquery/_category_.json similarity index 100% rename from apps/docs/docs/contribute/connect-data/bigquery/_category_.json rename to apps/docs/docs/contribute-data/bigquery/_category_.json diff --git a/apps/docs/docs/contribute/connect-data/bigquery/bigquery-open-perms.png b/apps/docs/docs/contribute-data/bigquery/bigquery-open-perms.png similarity index 100% rename from apps/docs/docs/contribute/connect-data/bigquery/bigquery-open-perms.png rename to apps/docs/docs/contribute-data/bigquery/bigquery-open-perms.png diff --git a/apps/docs/docs/contribute/connect-data/bigquery/bigquery-set-perms.png b/apps/docs/docs/contribute-data/bigquery/bigquery-set-perms.png similarity index 100% rename from apps/docs/docs/contribute/connect-data/bigquery/bigquery-set-perms.png rename to apps/docs/docs/contribute-data/bigquery/bigquery-set-perms.png diff --git a/apps/docs/docs/contribute/connect-data/bigquery/index.md b/apps/docs/docs/contribute-data/bigquery/index.md similarity index 100% rename from apps/docs/docs/contribute/connect-data/bigquery/index.md rename to apps/docs/docs/contribute-data/bigquery/index.md diff --git a/apps/docs/docs/contribute/connect-data/bigquery/replication.md b/apps/docs/docs/contribute-data/bigquery/replication.md similarity index 100% rename from apps/docs/docs/contribute/connect-data/bigquery/replication.md rename to apps/docs/docs/contribute-data/bigquery/replication.md diff --git a/apps/docs/docs/contribute/connect-data/dagster-config.mdx b/apps/docs/docs/contribute-data/dagster-config.mdx similarity index 89% rename from apps/docs/docs/contribute/connect-data/dagster-config.mdx rename to apps/docs/docs/contribute-data/dagster-config.mdx index 3b9c69ab7..cde910831 100644 --- a/apps/docs/docs/contribute/connect-data/dagster-config.mdx +++ b/apps/docs/docs/contribute-data/dagster-config.mdx @@ -96,6 +96,6 @@ from {{ source("ethereum", "transactions") }} ## Next steps -- [**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**](../data-models.md): contribute new impact and data models to our data pipeline +- [**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**](../contribute-models/data-models.md): contribute new impact and data models to our data pipeline diff --git a/apps/docs/docs/contribute/connect-data/dagster.md b/apps/docs/docs/contribute-data/dagster.md similarity index 100% rename from apps/docs/docs/contribute/connect-data/dagster.md rename to apps/docs/docs/contribute-data/dagster.md diff --git a/apps/docs/docs/contribute/connect-data/dagster_assets.png b/apps/docs/docs/contribute-data/dagster_assets.png similarity index 100% rename from apps/docs/docs/contribute/connect-data/dagster_assets.png rename to apps/docs/docs/contribute-data/dagster_assets.png diff --git a/apps/docs/docs/contribute/connect-data/dagster_deployments.png b/apps/docs/docs/contribute-data/dagster_deployments.png similarity index 100% rename from apps/docs/docs/contribute/connect-data/dagster_deployments.png rename to apps/docs/docs/contribute-data/dagster_deployments.png diff --git a/apps/docs/docs/contribute/connect-data/dagster_run.png b/apps/docs/docs/contribute-data/dagster_run.png similarity index 100% rename from apps/docs/docs/contribute/connect-data/dagster_run.png rename to apps/docs/docs/contribute-data/dagster_run.png diff --git a/apps/docs/docs/contribute/connect-data/database.md b/apps/docs/docs/contribute-data/database.md similarity index 100% rename from apps/docs/docs/contribute/connect-data/database.md rename to apps/docs/docs/contribute-data/database.md diff --git a/apps/docs/docs/contribute/connect-data/funding-data.md b/apps/docs/docs/contribute-data/funding-data.md similarity index 100% rename from apps/docs/docs/contribute/connect-data/funding-data.md rename to apps/docs/docs/contribute-data/funding-data.md diff --git a/apps/docs/docs/contribute/connect-data/gcs.md b/apps/docs/docs/contribute-data/gcs.md similarity index 100% rename from apps/docs/docs/contribute/connect-data/gcs.md rename to apps/docs/docs/contribute-data/gcs.md diff --git a/apps/docs/docs/contribute/connect-data/index.md b/apps/docs/docs/contribute-data/index.md similarity index 100% rename from apps/docs/docs/contribute/connect-data/index.md rename to apps/docs/docs/contribute-data/index.md diff --git a/apps/docs/docs/contribute/connect-data/quickstart.md b/apps/docs/docs/contribute-data/quickstart.md similarity index 100% rename from apps/docs/docs/contribute/connect-data/quickstart.md rename to apps/docs/docs/contribute-data/quickstart.md diff --git a/apps/docs/docs/contribute/_category_.json b/apps/docs/docs/contribute-models/_category_.json similarity index 53% rename from apps/docs/docs/contribute/_category_.json rename to apps/docs/docs/contribute-models/_category_.json index 2766fecf9..5e13b4063 100644 --- a/apps/docs/docs/contribute/_category_.json +++ b/apps/docs/docs/contribute-models/_category_.json @@ -1,6 +1,6 @@ { - "label": "Contribute To OSO", - "position": 2, + "label": "Contribute Models", + "position": 6, "link": { "type": "doc", "id": "index" diff --git a/apps/docs/docs/contribute/challenges/2024-04-05-data-challenge-01.md b/apps/docs/docs/contribute-models/challenges/2024-04-05-data-challenge-01.md similarity index 96% rename from apps/docs/docs/contribute/challenges/2024-04-05-data-challenge-01.md rename to apps/docs/docs/contribute-models/challenges/2024-04-05-data-challenge-01.md index ca4135292..9fa232377 100644 --- a/apps/docs/docs/contribute/challenges/2024-04-05-data-challenge-01.md +++ b/apps/docs/docs/contribute-models/challenges/2024-04-05-data-challenge-01.md @@ -72,7 +72,7 @@ Here’s what you need to do to participate in this (and future) data challenges 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). 2. Join our Discord and receive a **_data-collective_** role; ask questions and share code snippets in the **_#data-challenges_** channel. -3. Bookmark [our docs and tutorials](https://docs.opensource.observer/docs/how-oso-works/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. +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. 4. Submit your impact metric(s) by opening an issue on our Insight repo [here](https://github.com/opensource-observer/insights/issues/new/choose). Every impact metric submission should include: diff --git a/apps/docs/docs/contribute/challenges/2024-07-02-rf4-metrics-audit.md b/apps/docs/docs/contribute-models/challenges/2024-07-02-rf4-metrics-audit.md similarity index 100% rename from apps/docs/docs/contribute/challenges/2024-07-02-rf4-metrics-audit.md rename to apps/docs/docs/contribute-models/challenges/2024-07-02-rf4-metrics-audit.md diff --git a/apps/docs/docs/contribute/challenges/2024-07-30-openrank.md b/apps/docs/docs/contribute-models/challenges/2024-07-30-openrank.md similarity index 100% rename from apps/docs/docs/contribute/challenges/2024-07-30-openrank.md rename to apps/docs/docs/contribute-models/challenges/2024-07-30-openrank.md diff --git a/apps/docs/docs/contribute/challenges/_category_.json b/apps/docs/docs/contribute-models/challenges/_category_.json similarity index 100% rename from apps/docs/docs/contribute/challenges/_category_.json rename to apps/docs/docs/contribute-models/challenges/_category_.json diff --git a/apps/docs/docs/contribute/challenges/bounties.md b/apps/docs/docs/contribute-models/challenges/bounties.md similarity index 100% rename from apps/docs/docs/contribute/challenges/bounties.md rename to apps/docs/docs/contribute-models/challenges/bounties.md diff --git a/apps/docs/docs/contribute/challenges/index.md b/apps/docs/docs/contribute-models/challenges/index.md similarity index 100% rename from apps/docs/docs/contribute/challenges/index.md rename to apps/docs/docs/contribute-models/challenges/index.md diff --git a/apps/docs/docs/contribute/data-models.md b/apps/docs/docs/contribute-models/data-models.md similarity index 100% rename from apps/docs/docs/contribute/data-models.md rename to apps/docs/docs/contribute-models/data-models.md diff --git a/apps/docs/docs/contribute/data-scientist-meme.png b/apps/docs/docs/contribute-models/data-scientist-meme.png similarity index 100% rename from apps/docs/docs/contribute/data-scientist-meme.png rename to apps/docs/docs/contribute-models/data-scientist-meme.png diff --git a/apps/docs/docs/contribute/index.mdx b/apps/docs/docs/contribute-models/index.mdx similarity index 100% rename from apps/docs/docs/contribute/index.mdx rename to apps/docs/docs/contribute-models/index.mdx diff --git a/apps/docs/docs/contribute/join-team.mdx b/apps/docs/docs/contribute-models/join-team.mdx similarity index 100% rename from apps/docs/docs/contribute/join-team.mdx rename to apps/docs/docs/contribute-models/join-team.mdx diff --git a/apps/docs/docs/contribute/retrofunding.md b/apps/docs/docs/contribute-models/retrofunding.md similarity index 100% rename from apps/docs/docs/contribute/retrofunding.md rename to apps/docs/docs/contribute-models/retrofunding.md diff --git a/apps/docs/docs/contribute/share-insights.md b/apps/docs/docs/contribute-models/share-insights.md similarity index 97% rename from apps/docs/docs/contribute/share-insights.md rename to apps/docs/docs/contribute-models/share-insights.md index 2ff57cec9..35e99221a 100644 --- a/apps/docs/docs/contribute/share-insights.md +++ b/apps/docs/docs/contribute-models/share-insights.md @@ -31,7 +31,7 @@ Contribute your own data visualization templates by adding them to the `./visual ### Impact Metrcs -We're building scripts and analysis frameworks for community-generated impact metrics. Submissions must be replicable with data sourced entirely from the OSO data warehouse and should follow the follow the [Impact Metrics Specification](../how-oso-works/impact-metrics/). +We're building scripts and analysis frameworks for community-generated impact metrics. Submissions must be replicable with data sourced entirely from the OSO data warehouse and should follow the follow the [Impact Metrics Specification](../guides/impact-metrics/). In most cases, impact vectors will be reviewed and recognized via one of our Data Challenges, with separate instructions for showcasing work and submitting pull requests. diff --git a/apps/docs/docs/get-started/_category_.json b/apps/docs/docs/get-started/_category_.json new file mode 100644 index 000000000..64bcd4736 --- /dev/null +++ b/apps/docs/docs/get-started/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Get Started", + "position": 1, + "link": { + "type": "doc", + "id": "index" + } +} diff --git a/apps/docs/docs/get-started/api.mdx b/apps/docs/docs/get-started/api.mdx new file mode 100644 index 000000000..ada4568be --- /dev/null +++ b/apps/docs/docs/get-started/api.mdx @@ -0,0 +1,148 @@ +--- +title: "Get started with OSO API" +sidebar_position: 1 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +The [OSO](https://www.opensource.observer) API serves +queries on metrics and metadata about open source projects. +It is a [GraphQL](https://graphql.org/) API backed by the +[OSO data pipeline](../guides/architecture.md). + +Let's make your first query in under five minutes. + +## Generate an API key + +First, go to [www.opensource.observer](https://www.opensource.observer) and create a new account. + +If you already have an account, log in. Then create a new personal API key: + +1. Go to [Account settings](https://www.opensource.observer/app/settings) +2. In the "API Keys" section, click "+ New" +3. Give your key a label - this is just for you, usually to describe a key's purpose. +4. You should see your brand new key. **Immediately** save this value, as you'll **never** see it again after refreshing the page. +5. Click "Create" to save the key. + + +![generate API key](../integrate/generate-api-key.png) + +## Prepare your query + +You can navigate to our +[public GraphQL explorer](https://www.opensource.observer/graphql) +to explore the schema and execute test queries. + +![GraphQL explorer](../integrate/api-explorer.gif) + +For example, this query will fetch the first 10 projects in +[oss-directory](https://github.com/opensource-observer/oss-directory). + +```graphql +query GetProjects { + oso_projectsV1(limit: 10) { + description + displayName + projectId + projectName + projectNamespace + projectSource + } +} +``` + +## Issue your first API request + +All API requests are sent to the following URL: + +``` +https://www.opensource.observer/api/v1/graphql +``` + +In order to authenticate with the API service, you have to use the `Authorization` HTTP header and `Bearer` authentication on all HTTP requests + + + + +```bash +curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DEVELOPER_API_KEY" \ + -d '{"query":"query GetProjects { oso_projectsV1(limit: 10) { description displayName projectId projectName projectNamespace projectSource } }"}' \ + https://www.opensource.observer/api/v1/graphql +``` + + + ```js + const query = ` + query GetProjects { + oso_projectsV1(limit: 10) { + description + displayName + projectId + projectName + projectNamespace + projectSource + } + } + `; +const headers = { + 'Content-Type': 'application/json', + 'Authorization': `Bearer ${DEVELOPER_API_KEY}`, +}; + +const response = await fetch('https://www.opensource.observer/api/v1/graphql', { + method: 'POST', + headers: headers, + body: JSON.stringify({ + query: query + }), +}); + +const data = await response.json(); +console.log(data); +``` + + +```python +import requests + +query = """ +query GetProjects { + oso_projectsV1(limit: 10) { + description + displayName + projectId + projectName + projectNamespace + projectSource + } +} +""" + +headers = { + 'Content-Type': 'application/json', + 'Authorization': f'Bearer {DEVELOPER_API_KEY}' +} + +response = requests.post( + 'https://www.opensource.observer/api/v1/graphql', + json={'query': query}, + headers=headers +) + +data = response.json() +print(data) +``` + + + + +## Next steps + +Congratulations! You've made your first API request. +Now try one of our tutorials. + +- [Analyze a collection of projects](../tutorials/collection-view) +- [Deep dive into a project](../tutorials/project-deepdive) \ No newline at end of file diff --git a/apps/docs/docs/get-started/index.mdx b/apps/docs/docs/get-started/bigquery.mdx similarity index 77% rename from apps/docs/docs/get-started/index.mdx rename to apps/docs/docs/get-started/bigquery.mdx index 463a26c03..5e99ac2f9 100644 --- a/apps/docs/docs/get-started/index.mdx +++ b/apps/docs/docs/get-started/bigquery.mdx @@ -1,24 +1,16 @@ --- -title: Get Started -sidebar_position: 1 +title: "Get started with BigQuery" +sidebar_position: 2 --- import Link from "@docusaurus/Link"; import Button from "../../src/components/plasmic/Button"; -:::info -There are two easy ways of accessing OSO datasets: through our GraphQL API -and through our data warehouse on BigQuery. -For live integrations, you'll want [API access](../integrate/api.md). -For exploratory analysis and impact data science, -it's best to go direct to the data warehouse. -::: OSO's data warehouse is currently located in BigQuery on Google Cloud (GCP). Every data model is made publicly available by a BigQuery dataset. -See our [data overview](../integrate/overview/index.mdx) -for a full list of public data sets. +Let's make your first query in under five minutes. ## Sign up for Google Cloud @@ -38,7 +30,7 @@ and answer a few marketing questions. :::tip GCP offers a free tier that includes $300 in credits. After that, it is easy to stay in the free tier provided you remain under the -1TB per month limit for BigQuery data processed (more on that later). +1TB per month limit for BigQuery data processed. ::: Finally, you will be brought to the admin console where you can create a new project. @@ -117,19 +109,5 @@ Now that you're set up, there are many ways to contribute to OSO and integrate t - [SQL Query Guide](../integrate/query-data.mdx) for more details on running effective queries - [Write Python notebooks](../integrate/python-notebooks.md) for advanced analysis and visualizations -- [Propose an impact model](../contribute/data-models.md) to run in the OSO data pipeline +- [Propose an impact model](../contribute-models/data-models.md) to run in the OSO data pipeline - [Query the OSO API](../integrate/api.md) for impact metrics and project info to integrate into your application - -If you think you'll be an ongoing contributor to OSO, -please apply to join the [Kariba Data Collective](https://www.kariba.network). - -Membership is free but we want to keep the community close-knit and mission-aligned. -As the community grows, we want to reward the most useful contributions and -in so doing create a [new job category for impact data science](https://docs.opensource.observer/blog/impact-data-scientists). - - - Join the Data Collective - diff --git a/apps/docs/docs/get-started/index.md b/apps/docs/docs/get-started/index.md new file mode 100644 index 000000000..9de5fd637 --- /dev/null +++ b/apps/docs/docs/get-started/index.md @@ -0,0 +1,21 @@ +--- +title: "Get started" +sidebar_position: 0 +--- + +[Open Source Observer](https://www.opensource.observer) +is a community effort for measuring the impact of open source software. +Our data and models evolve with the community in a way that is +[open source, open data, open infrastructure](../../blog/open-source-open-data-open-infra). + +There are two easy ways of accessing OSO datasets: +through our GraphQL API +and through our data warehouse on BigQuery. + +- For live integrations in a production application, you'll want [API access](./api.mdx). +- For exploratory analysis and data science, go direct to the [data warehouse](./bigquery.mdx). + +If you think you'll be an ongoing contributor to OSO, +please apply to join the [Kariba Data Collective](https://www.kariba.network). + +![oso](./triple-circle-oso.png) diff --git a/apps/docs/docs/get-started/python.md b/apps/docs/docs/get-started/python.md new file mode 100644 index 000000000..4c13120c8 --- /dev/null +++ b/apps/docs/docs/get-started/python.md @@ -0,0 +1,8 @@ +--- +title: "🏗 Get started with Python" +sidebar_position: 3 +sidebar_class_name: hidden +--- + +This page is a work in progress. +To track progress, see [this epic](https://github.com/opensource-observer/oso/milestone/16). diff --git a/apps/docs/docs/get-started/triple-circle-oso.png b/apps/docs/docs/get-started/triple-circle-oso.png new file mode 100644 index 000000000..4fa328761 Binary files /dev/null and b/apps/docs/docs/get-started/triple-circle-oso.png differ diff --git a/apps/docs/docs/how-oso-works/1_oss_directory.png b/apps/docs/docs/guides/1_oss_directory.png similarity index 100% rename from apps/docs/docs/how-oso-works/1_oss_directory.png rename to apps/docs/docs/guides/1_oss_directory.png diff --git a/apps/docs/docs/how-oso-works/2_artifacts.png b/apps/docs/docs/guides/2_artifacts.png similarity index 100% rename from apps/docs/docs/how-oso-works/2_artifacts.png rename to apps/docs/docs/guides/2_artifacts.png diff --git a/apps/docs/docs/how-oso-works/3_events.png b/apps/docs/docs/guides/3_events.png similarity index 100% rename from apps/docs/docs/how-oso-works/3_events.png rename to apps/docs/docs/guides/3_events.png diff --git a/apps/docs/docs/how-oso-works/4_impact_metrics.png b/apps/docs/docs/guides/4_impact_metrics.png similarity index 100% rename from apps/docs/docs/how-oso-works/4_impact_metrics.png rename to apps/docs/docs/guides/4_impact_metrics.png diff --git a/apps/docs/docs/guides/_category_.json b/apps/docs/docs/guides/_category_.json new file mode 100644 index 000000000..a33e75dca --- /dev/null +++ b/apps/docs/docs/guides/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Guides", + "position": 7, + "link": { + "type": "doc", + "id": "index" + } +} diff --git a/apps/docs/docs/how-oso-works/architecture.md b/apps/docs/docs/guides/architecture.md similarity index 100% rename from apps/docs/docs/how-oso-works/architecture.md rename to apps/docs/docs/guides/architecture.md diff --git a/apps/docs/docs/how-oso-works/ecosystems/_category_.json b/apps/docs/docs/guides/ecosystems/_category_.json similarity index 100% rename from apps/docs/docs/how-oso-works/ecosystems/_category_.json rename to apps/docs/docs/guides/ecosystems/_category_.json diff --git a/apps/docs/docs/how-oso-works/ecosystems/arbitrum.md b/apps/docs/docs/guides/ecosystems/arbitrum.md similarity index 100% rename from apps/docs/docs/how-oso-works/ecosystems/arbitrum.md rename to apps/docs/docs/guides/ecosystems/arbitrum.md diff --git a/apps/docs/docs/how-oso-works/ecosystems/pln.md b/apps/docs/docs/guides/ecosystems/pln.md similarity index 100% rename from apps/docs/docs/how-oso-works/ecosystems/pln.md rename to apps/docs/docs/guides/ecosystems/pln.md diff --git a/apps/docs/docs/how-oso-works/ecosystems/superchain.md b/apps/docs/docs/guides/ecosystems/superchain.md similarity index 100% rename from apps/docs/docs/how-oso-works/ecosystems/superchain.md rename to apps/docs/docs/guides/ecosystems/superchain.md diff --git a/apps/docs/docs/how-oso-works/event.md b/apps/docs/docs/guides/event.md similarity index 100% rename from apps/docs/docs/how-oso-works/event.md rename to apps/docs/docs/guides/event.md diff --git a/apps/docs/docs/how-oso-works/impact-metrics/_category_.json b/apps/docs/docs/guides/impact-metrics/_category_.json similarity index 100% rename from apps/docs/docs/how-oso-works/impact-metrics/_category_.json rename to apps/docs/docs/guides/impact-metrics/_category_.json diff --git a/apps/docs/docs/how-oso-works/impact-metrics/code.md b/apps/docs/docs/guides/impact-metrics/code.md similarity index 98% rename from apps/docs/docs/how-oso-works/impact-metrics/code.md rename to apps/docs/docs/guides/impact-metrics/code.md index c75d2ae9d..1ff44d114 100644 --- a/apps/docs/docs/how-oso-works/impact-metrics/code.md +++ b/apps/docs/docs/guides/impact-metrics/code.md @@ -76,4 +76,4 @@ The latest version of our code metrics model can be viewed [here](https://models --- -To contribute new metrics, please see our guide [here](../../contribute/data-models). +To contribute new metrics, please see our guide [here](../../contribute-models/data-models). diff --git a/apps/docs/docs/how-oso-works/impact-metrics/dependencies.md b/apps/docs/docs/guides/impact-metrics/dependencies.md similarity index 99% rename from apps/docs/docs/how-oso-works/impact-metrics/dependencies.md rename to apps/docs/docs/guides/impact-metrics/dependencies.md index 01fedf9e2..66de27f81 100644 --- a/apps/docs/docs/how-oso-works/impact-metrics/dependencies.md +++ b/apps/docs/docs/guides/impact-metrics/dependencies.md @@ -100,4 +100,4 @@ Total sequencer fees of all dependent projects in the same collection. --- -To contribute new metrics, please see our guide [here](../../contribute/data-models) +To contribute new metrics, please see our guide [here](../../contribute-models/data-models) diff --git a/apps/docs/docs/how-oso-works/impact-metrics/index.mdx b/apps/docs/docs/guides/impact-metrics/index.mdx similarity index 99% rename from apps/docs/docs/how-oso-works/impact-metrics/index.mdx rename to apps/docs/docs/guides/impact-metrics/index.mdx index aa47e8c4b..4f6ccb55a 100644 --- a/apps/docs/docs/how-oso-works/impact-metrics/index.mdx +++ b/apps/docs/docs/guides/impact-metrics/index.mdx @@ -198,4 +198,4 @@ Here's a more complex impact metric that uses several CTEs to calculate the numb --- -To contribute new metrics, please see our guide [here](../../contribute/data-models). +To contribute new metrics, please see our guide [here](../../contribute-models/data-models). diff --git a/apps/docs/docs/how-oso-works/impact-metrics/onchain.md b/apps/docs/docs/guides/impact-metrics/onchain.md similarity index 98% rename from apps/docs/docs/how-oso-works/impact-metrics/onchain.md rename to apps/docs/docs/guides/impact-metrics/onchain.md index 8a92f867e..9ac2da657 100644 --- a/apps/docs/docs/how-oso-works/impact-metrics/onchain.md +++ b/apps/docs/docs/guides/impact-metrics/onchain.md @@ -72,4 +72,4 @@ The latest version of our code metrics model can be viewed [here](https://models --- -To contribute new metrics, please see our guide [here](../../contribute/data-models). +To contribute new metrics, please see our guide [here](../../contribute-models/data-models). diff --git a/apps/docs/docs/how-oso-works/impact-metrics/package.md b/apps/docs/docs/guides/impact-metrics/package.md similarity index 95% rename from apps/docs/docs/how-oso-works/impact-metrics/package.md rename to apps/docs/docs/guides/impact-metrics/package.md index e98e08318..9e10cdcdb 100644 --- a/apps/docs/docs/how-oso-works/impact-metrics/package.md +++ b/apps/docs/docs/guides/impact-metrics/package.md @@ -22,4 +22,4 @@ Number of times a package has been downloaded over a given time period. --- -To contribute new metrics, please see our guide [here](../../contribute/data-models). +To contribute new metrics, please see our guide [here](../../contribute-models/data-models). diff --git a/apps/docs/docs/how-oso-works/index.mdx b/apps/docs/docs/guides/index.mdx similarity index 100% rename from apps/docs/docs/how-oso-works/index.mdx rename to apps/docs/docs/guides/index.mdx diff --git a/apps/docs/docs/how-oso-works/mission.md b/apps/docs/docs/guides/mission.md similarity index 88% rename from apps/docs/docs/how-oso-works/mission.md rename to apps/docs/docs/guides/mission.md index 150446590..e94c3b393 100644 --- a/apps/docs/docs/how-oso-works/mission.md +++ b/apps/docs/docs/guides/mission.md @@ -35,4 +35,4 @@ At the same time, we're building a network of **impact data scientists** who can ## How can I contribute? -We were hoping you'd ask! There are a variety of ways to contribute to Open Source Observer. The best place to start is [here](../contribute). If you are interested in joining the Data Collective, you can apply [here](https://www.kariba.network). You should also join our [Telegram](https://t.me/opensourceobserver) and our [Discord](https://www.opensource.observer/discord) communities to stay informed of the latest updates. +We were hoping you'd ask! There are a variety of ways to contribute to Open Source Observer. The best place to start is [here](../projects). If you are interested in joining the Data Collective, you can apply [here](https://www.kariba.network). You should also join our [Telegram](https://t.me/opensourceobserver) and our [Discord](https://www.opensource.observer/discord) communities to stay informed of the latest updates. diff --git a/apps/docs/docs/how-oso-works/ops/_category_.json b/apps/docs/docs/guides/ops/_category_.json similarity index 100% rename from apps/docs/docs/how-oso-works/ops/_category_.json rename to apps/docs/docs/guides/ops/_category_.json diff --git a/apps/docs/docs/how-oso-works/ops/gcloud.md b/apps/docs/docs/guides/ops/gcloud.md similarity index 100% rename from apps/docs/docs/how-oso-works/ops/gcloud.md rename to apps/docs/docs/guides/ops/gcloud.md diff --git a/apps/docs/docs/how-oso-works/ops/hasura.md b/apps/docs/docs/guides/ops/hasura.md similarity index 100% rename from apps/docs/docs/how-oso-works/ops/hasura.md rename to apps/docs/docs/guides/ops/hasura.md diff --git a/apps/docs/docs/how-oso-works/ops/index.md b/apps/docs/docs/guides/ops/index.md similarity index 53% rename from apps/docs/docs/how-oso-works/ops/index.md rename to apps/docs/docs/guides/ops/index.md index 51ab697f0..47ff9e1df 100644 --- a/apps/docs/docs/how-oso-works/ops/index.md +++ b/apps/docs/docs/guides/ops/index.md @@ -1,14 +1,15 @@ --- title: Overview -sidebar_position: 1 +sidebar_position: 0 --- +[OSO Service Definition](./service) + The OSO architecture runs on the following platforms: -- Vercel: used to build and host the [frontend](https://www.opensource.observer), as well as the [documentation](https://docs.opensource.observer) -- [GitHub Actions](https://github.com/opensource-observer/oso/actions): used to continuously deploy everything else, including the data pipeline. +- Vercel: used to build and host the [frontend](https://www.opensource.observer) +- Cloudflare Pages: used to host the [documentation](https://docs.opensource.observer) +- [GitHub Actions](https://github.com/opensource-observer/oso/actions): used for CI/CD - [Google Cloud](./gcloud) - - BigQuery - the data warehouse - - CloudSQL - stores materialized views of the processed data for the API - [Hasura](./hasura) - GraphQL API service - [Supabase](./supabase) - user authentication and user database diff --git a/apps/docs/docs/guides/ops/service.md b/apps/docs/docs/guides/ops/service.md new file mode 100644 index 000000000..a4ec3bfd7 --- /dev/null +++ b/apps/docs/docs/guides/ops/service.md @@ -0,0 +1,31 @@ +--- +title: OSO Service +sidebar_position: 1 +--- + +The OSO team aims to provide reliable infrastructure as a public good +for the community to build upon. +This document should not be treated as a guarantee of service +or service-level agreement (SLA). +Rather, this document should serve as a reference and shared target +that the community aims to achieve together. + +## Service Status + +## Service Definition + +OSO is constantly experimenting with new technology and services +to improve our infrastructure. +We only aim to provide service availability for the following mature services: + +- [Dagster](https://data.opensource.observer) +- [dbt pipeline](https://dbt.opensource.observer) +- [API](https://api.opensource.observer) +- [Frontend](https://www.opensource.observer) +- [Documentation](https://docs.opensource.observer) + +_Note: the sqlmesh pipeline is currently in development and not yet reliable for production use_ + +## Outage Escalation + +There are 2 surfaces diff --git a/apps/docs/docs/how-oso-works/ops/supabase.md b/apps/docs/docs/guides/ops/supabase.md similarity index 100% rename from apps/docs/docs/how-oso-works/ops/supabase.md rename to apps/docs/docs/guides/ops/supabase.md diff --git a/apps/docs/docs/how-oso-works/oss-directory/_category_.json b/apps/docs/docs/guides/oss-directory/_category_.json similarity index 100% rename from apps/docs/docs/how-oso-works/oss-directory/_category_.json rename to apps/docs/docs/guides/oss-directory/_category_.json diff --git a/apps/docs/docs/how-oso-works/oss-directory/artifact.md b/apps/docs/docs/guides/oss-directory/artifact.md similarity index 97% rename from apps/docs/docs/how-oso-works/oss-directory/artifact.md rename to apps/docs/docs/guides/oss-directory/artifact.md index 5eb691178..212d6559f 100644 --- a/apps/docs/docs/how-oso-works/oss-directory/artifact.md +++ b/apps/docs/docs/guides/oss-directory/artifact.md @@ -200,4 +200,4 @@ The full schema for the blockchain address field is as follows. Note that it inc --- -Artifacts are updated and added to the OSS Directory by members of the Data Collective. To learn more about contributing to the OSS Directory, start [here](../../contribute/project-data). If you are interested in joining the Data Collective, you can apply [here](https://www.kariba.network/). +Artifacts are updated and added to the OSS Directory by members of the Data Collective. To learn more about contributing to the OSS Directory, start [here](../../projects). If you are interested in joining the Data Collective, you can apply [here](https://www.kariba.network/). diff --git a/apps/docs/docs/how-oso-works/oss-directory/collection.md b/apps/docs/docs/guides/oss-directory/collection.md similarity index 100% rename from apps/docs/docs/how-oso-works/oss-directory/collection.md rename to apps/docs/docs/guides/oss-directory/collection.md diff --git a/apps/docs/docs/how-oso-works/oss-directory/index.md b/apps/docs/docs/guides/oss-directory/index.md similarity index 100% rename from apps/docs/docs/how-oso-works/oss-directory/index.md rename to apps/docs/docs/guides/oss-directory/index.md diff --git a/apps/docs/docs/how-oso-works/oss-directory/project.md b/apps/docs/docs/guides/oss-directory/project.md similarity index 95% rename from apps/docs/docs/how-oso-works/oss-directory/project.md rename to apps/docs/docs/guides/oss-directory/project.md index 49dea01ca..597057a38 100644 --- a/apps/docs/docs/how-oso-works/oss-directory/project.md +++ b/apps/docs/docs/guides/oss-directory/project.md @@ -109,4 +109,4 @@ You can always access the most recent version of the schema [here](https://githu --- -Projects are updated and added to the OSS Directory by members of the Data Collective. To learn more about contributing to the OSS Directory, start [here](../../contribute/project-data). If you are interested in joining the Data Collective, you can apply [here](https://www.kariba.network). +Projects are updated and added to the OSS Directory by members of the Data Collective. To learn more about contributing to the OSS Directory, start [here](../../projects). If you are interested in joining the Data Collective, you can apply [here](https://www.kariba.network). diff --git a/apps/docs/docs/how-oso-works/oss-directory/schema-updates.md b/apps/docs/docs/guides/oss-directory/schema-updates.md similarity index 100% rename from apps/docs/docs/how-oso-works/oss-directory/schema-updates.md rename to apps/docs/docs/guides/oss-directory/schema-updates.md diff --git a/apps/docs/docs/how-oso-works/style-guide.md b/apps/docs/docs/guides/style-guide.md similarity index 100% rename from apps/docs/docs/how-oso-works/style-guide.md rename to apps/docs/docs/guides/style-guide.md diff --git a/apps/docs/docs/integrate/_category_.json b/apps/docs/docs/integrate/_category_.json index da0fc9286..b16ff6a78 100644 --- a/apps/docs/docs/integrate/_category_.json +++ b/apps/docs/docs/integrate/_category_.json @@ -1,5 +1,5 @@ { - "label": "Get OSO Data", + "label": "Get Data", "position": 3, "link": { "type": "doc", diff --git a/apps/docs/docs/integrate/api.md b/apps/docs/docs/integrate/api.md index 5af2d29c6..710ee9724 100644 --- a/apps/docs/docs/integrate/api.md +++ b/apps/docs/docs/integrate/api.md @@ -95,7 +95,7 @@ You can navigate to our [public GraphQL explorer](https://www.opensource.observe As shown in the video, you must "Inline Variables" in order for queries to run in the explorer. ::: -The GraphQL schema is automatically generated from [`oso/dbt/models/marts`](https://github.com/opensource-observer/oso/tree/main/dbt/models/marts). Any dbt model defined there will automatically be exported to our GraphQL API. See the guide on [adding DBT models](../contribute/data-models.md) for more information on contributing to our marts models. +The GraphQL schema is automatically generated from [`oso/dbt/models/marts`](https://github.com/opensource-observer/oso/tree/main/dbt/models/marts). Any dbt model defined there will automatically be exported to our GraphQL API. See the guide on [adding DBT models](../contribute-models/data-models.md) for more information on contributing to our marts models. :::warning Our data pipeline is under heavy development and all table schemas are subject to change until we introduce versioning to marts models. diff --git a/apps/docs/docs/integrate/index.md b/apps/docs/docs/integrate/index.md index daecb668d..be765fb14 100644 --- a/apps/docs/docs/integrate/index.md +++ b/apps/docs/docs/integrate/index.md @@ -6,7 +6,7 @@ sidebar_position: 0 Open Source Observer is a fully open data pipeline for measuring the impact of open source efforts. That means all source code, data, and infrastructure is publicly available for use. -- [**Get Started**](../get-started/index.mdx): to setup your Google account for data access and run your first query +- [**Get Started**](../get-started/index.md): to setup your Google account for data access and run your first query - [**Data Overview**](./overview/index.mdx): for an overview of all data available - [**SQL Query Guide**](./query-data.mdx): to quickly query and download any data - [**Python notebooks**](./python-notebooks.md): to do more in-depth data science and processing diff --git a/apps/docs/docs/integrate/overview/index.mdx b/apps/docs/docs/integrate/overview/index.mdx index 24e09df27..9cb2368bb 100644 --- a/apps/docs/docs/integrate/overview/index.mdx +++ b/apps/docs/docs/integrate/overview/index.mdx @@ -19,7 +19,7 @@ import EasLogo from "./eas.png"; import OcLogo from "./open-collective.png"; First, you need to set up your BigQuery account. You can do this by going to the -[Get Started](../../get-started/index.mdx) +[Get Started](../../get-started/index.md) page. ## OSO Data Exchange on Analytics Hub @@ -87,9 +87,9 @@ in a live production application._ From source data, we produce a "universal event table", currently stored at [`int_events`](https://models.opensource.observer/#!/model/model.opensource_observer.int_events). -Each event consists of an [event_type](../../how-oso-works/event.md) +Each event consists of an [event_type](../../guides/event.md) (e.g. a git commit or contract invocation), -[to/from artifacts](../../how-oso-works/oss-directory/artifact.md), +[to/from artifacts](../../guides/oss-directory/artifact.md), a timestamp, and an amount. From this event table, we aggregate events in downstream models to produce our metrics. diff --git a/apps/docs/docs/integrate/python-notebooks.md b/apps/docs/docs/integrate/python-notebooks.md index e2d706502..95eb93d0e 100644 --- a/apps/docs/docs/integrate/python-notebooks.md +++ b/apps/docs/docs/integrate/python-notebooks.md @@ -6,7 +6,7 @@ sidebar_position: 4 Python notebooks are a great way for data scientists to explore data, organize ad-hoc analysis, and share insights. We've included several template notebooks to help you get started working with OSO data. You can find these on [Google Colab](https://drive.google.com/drive/folders/1mzqrSToxPaWhsoGOR-UVldIsaX1gqP0F?usp=drive_link) and in the [community directory](https://github.com/opensource-observer/insights/tree/main/community/notebooks) of our insights repo. We encourage you to share your analysis and visualizations with the OSO community. You will need access to the OSO data warehouse to do data science. -See our getting started guide [here](../get-started/index.mdx). +See our getting started guide [here](../get-started/index.md). ## Fetching Data @@ -211,7 +211,7 @@ Alternatively, you can stick to static analysis and export your data from BigQue #### Obtain a GCP Service Account Key -This section will walk you through the process of obtaining a GCP service account key and connecting to BigQuery from a Jupyter notebook. If you don't have a GCP account, you will need to create one (see [here](../get-started/index.mdx) for instructions). +This section will walk you through the process of obtaining a GCP service account key and connecting to BigQuery from a Jupyter notebook. If you don't have a GCP account, you will need to create one (see [here](../get-started/index.md) for instructions). From the [GCP Console](https://console.cloud.google.com/), navigate to the BigQuery API page by clicking **API & Services** > **Enabled APIs & services** > **BigQuery API**. @@ -496,7 +496,7 @@ An **impact metric** is essentially a SQL query made against the OSO dataset tha There are a variety of statistical techniques for analyzing data about impact metrics and identifying trends. This section provides a basic example of how to create an impact metric and run a distribution analysis. :::tip -The complete specification for an impact metric is available [here](../how-oso-works/impact-metrics/index.mdx). +The complete specification for an impact metric is available [here](../guides/impact-metrics/index.mdx). ::: ### General guide for creating an impact metric @@ -508,13 +508,13 @@ The complete specification for an impact metric is available [here](../how-oso-w #### 2. Define the Metric and Selection Criteria -- **Metric**: Get inspiration from some of our [impact metrics](../how-oso-works/impact-metrics/index.mdx) or [propose a new metric](../contribute/data-models.md). Examples: "Number of Full-Time Developer Months", "Number of Dependent Onchain Apps", "Layer 2 Gas Fees", "Number of New Contributors". +- **Metric**: Get inspiration from some of our [impact metrics](../guides/impact-metrics/index.mdx) or [propose a new metric](../contribute-models/data-models.md). Examples: "Number of Full-Time Developer Months", "Number of Dependent Onchain Apps", "Layer 2 Gas Fees", "Number of New Contributors". - **Time Period**: Specify a time interval for applying the metric. Examples: "Last 6 months", "Since the project's inception". - **Selection Filter**: Make explicit the criteria to identify which projects are eligible (or ineligible) to be included in the analysis. Examples: "Projects with developer activity in the last 90 days", "Projects with NPM packages used by at least 5 onchain projects", "Projects with a permissive open source license (e.g., MIT, Apache 2.0) and a codebase that is at least 6 months old". #### 3. Normalize the Data -- **Query Logic**: Provide the code that fetches the metrics for each project in the selection set. The query may only make use of datasets that are public and in the OSO data warehouse. (Contribute new pubic datasets [here](../contribute/connect-data/index.md).) +- **Query Logic**: Provide the code that fetches the metrics for each project in the selection set. The query may only make use of datasets that are public and in the OSO data warehouse. (Contribute new pubic datasets [here](../contribute-data/index.md).) - **Normalization Method**: Choose an appropriate method for normalizing the metric data (e.g., Gaussian distribution, log scale) that fits the metric characteristics. The script in the tutorial (see next section) includes an example of a normalization method you can start with. #### 4. Optional: Share Your Analysis diff --git a/apps/docs/docs/integrate/query-data.mdx b/apps/docs/docs/integrate/query-data.mdx index 1133159a6..cbd67f520 100644 --- a/apps/docs/docs/integrate/query-data.mdx +++ b/apps/docs/docs/integrate/query-data.mdx @@ -11,7 +11,7 @@ initiative, we are making OSO data as widely available as possible. Use this guide to download the latest data for our own data stack. Please refer to the -[getting started](../get-started/index.mdx) +[getting started](../get-started/index.md) guide to first get your BigQuery account setup. ## Subscribe an OSO dataset @@ -93,4 +93,4 @@ If there is an intermediate model addition (such as a new event type or aggregation) that you think could help save costs for others in the future, please consider contributing to our -[data models](../contribute/data-models.md). +[data models](../contribute-models/data-models.md). diff --git a/apps/docs/docs/contribute/project-data.md b/apps/docs/docs/projects/index.md similarity index 98% rename from apps/docs/docs/contribute/project-data.md rename to apps/docs/docs/projects/index.md index cddc7b42d..fc44b2f9b 100644 --- a/apps/docs/docs/contribute/project-data.md +++ b/apps/docs/docs/projects/index.md @@ -137,7 +137,7 @@ In previous versions of the schema, we enumerated contracts and factories with t - `contract`: A smart contract address. - `factory`: A factory contract address. -Read below for more detailed steps on how to add or update project data or consult the [schema](../how-oso-works/oss-directory/) for more information. +Read below for more detailed steps on how to add or update project data or consult the [schema](../guides/oss-directory/) for more information. ## Add or Update Project Data (Detailed Steps) @@ -170,14 +170,14 @@ If you run into issues, check out [GitHub's instructions](https://docs.github.co - If the project doesn't exist, you can create a new `.yaml` file under `./data/projects/` In most cases, you should simply use the GitHub organization name (eg, `my-new-org`) as the name and filename (eg, `./data/projectsm/my-new-org.yaml`). - If the project is not associated with a GitHub organization, you can use the project name followed by the repo owner as the name, separated by hyphens (eg, `my-repo-my-org`), and the same convention for the filename (eg, `./data/projects/m/my-repo-my-org.yaml`). - Initialize the new project with the following fields: - - `version`: The version of the schema you are using. The latest version is Version 7. You can learn more about the schema [here](../how-oso-works/oss-directory/schema-updates). + - `version`: The version of the schema you are using. The latest version is Version 7. You can learn more about the schema [here](../guides/oss-directory/schema-updates). - `name`: The unique identifier for the project. See [Project Names](#project-names) for more information. - `display_name`: The name of the project. - `github`: The GitHub URL of the project. This is a list of URLs, as a project can have multiple GitHub URLs. In most cases, the first and only URL will be the main GitHub organization URL. You don't need to include all the repositories that belong to the organization, as we will automatically index all of them. ### 3. Link artifacts to the project -- Add artifacts to the project file. Artifacts are the different types of data that we index for a project. You can find the list of artifacts in the [schema](../how-oso-works/oss-directory/artifact). Here's an example of a project file with artifacts: +- Add artifacts to the project file. Artifacts are the different types of data that we index for a project. You can find the list of artifacts in the [schema](../guides/oss-directory/artifact). Here's an example of a project file with artifacts: ```yaml version: diff --git a/apps/docs/docs/references/_category_.json b/apps/docs/docs/references/_category_.json index 187be6fce..5a82e5a01 100644 --- a/apps/docs/docs/references/_category_.json +++ b/apps/docs/docs/references/_category_.json @@ -1,6 +1,6 @@ { "label": "References", - "position": 6, + "position": 8, "link": { "type": "doc", "id": "index" diff --git a/apps/docs/docs/references/faq.md b/apps/docs/docs/references/faq.md index 0c33d7815..c68de058b 100644 --- a/apps/docs/docs/references/faq.md +++ b/apps/docs/docs/references/faq.md @@ -8,7 +8,7 @@ sidebar_position: 5 ### How is OSO supported? Open Source Observer is a public good. -All of our code is [open source](https://github.com/opensource-observer/oso/) +All of our code is [open source](https://github.com/opensource-observer/oso/). All of our data sets and models are [open data](../integrate/overview/index.mdx). All of our infrastructure is [open](https://dagster.opensource.observer/locations) too. If we are going to transform funding for public goods, @@ -27,7 +27,7 @@ to introduce yourself and ask questions. If you know what you're looking for, our docs are the best place to search for the answer. We do also occasionally host public -[data challenges](../contribute/challenges/index.md) +[data challenges](../contribute-models/challenges/index.md) if you're looking for more structure. --- @@ -44,7 +44,7 @@ In order to instruct the indexer to also analyze your project, you must add your project to [oss-directory](https://github.com/opensource-observer/oss-directory/). We have detailed instructions on how to do that -[here](../contribute/project-data.md). +[here](../projects). ### How often do you index / refresh your data? diff --git a/apps/docs/docs/contribute/connect-data/_category_.json b/apps/docs/docs/tutorials/_category_.json similarity index 69% rename from apps/docs/docs/contribute/connect-data/_category_.json rename to apps/docs/docs/tutorials/_category_.json index d6a76a91e..39a6d5c73 100644 --- a/apps/docs/docs/contribute/connect-data/_category_.json +++ b/apps/docs/docs/tutorials/_category_.json @@ -1,5 +1,5 @@ { - "label": "Connect Your Data", + "label": "Tutorials", "position": 4, "link": { "type": "doc", diff --git a/apps/docs/docs/use-cases/collection-view.md b/apps/docs/docs/tutorials/collection-view.md similarity index 98% rename from apps/docs/docs/use-cases/collection-view.md rename to apps/docs/docs/tutorials/collection-view.md index 389fb1df5..763ce0d7b 100644 --- a/apps/docs/docs/use-cases/collection-view.md +++ b/apps/docs/docs/tutorials/collection-view.md @@ -3,7 +3,7 @@ title: Analyze a Collection of Projects sidebar_position: 1 --- -Get a high level view of key metrics for a collection of projects. New to OSO? Check out our [Getting Started guide](../get-started/index.mdx) to set up your BigQuery or API access. +Get a high level view of key metrics for a collection of projects. New to OSO? Check out our [Getting Started guide](../get-started/index.md) to set up your BigQuery or API access. :::tip All **collections** are defined as YAML files in [OSS Directory](https://github.com/opensource-observer/oss-directory). View our current collections [here](https://github.com/opensource-observer/oss-directory/tree/main/data/collections). @@ -262,4 +262,4 @@ df = client.query(query).to_dataframe() Projects and collections are defined as YAML files in our [OSS Directory repo](https://github.com/opensource-observer/oss-directory). You can add or update your own collections and projects by submitting a pull request. -For more information on how collections work, see our guide [here](../how-oso-works/oss-directory/collection.md). +For more information on how collections work, see our guide [here](../guides/oss-directory/collection.md). diff --git a/apps/docs/docs/use-cases/index.md b/apps/docs/docs/tutorials/index.md similarity index 98% rename from apps/docs/docs/use-cases/index.md rename to apps/docs/docs/tutorials/index.md index 52c84ec8f..82bf60b6b 100644 --- a/apps/docs/docs/use-cases/index.md +++ b/apps/docs/docs/tutorials/index.md @@ -1,6 +1,6 @@ --- title: Tutorials -sidebar_position: 4 +sidebar_position: 0 --- # Tutorials diff --git a/apps/docs/docs/use-cases/network-graph.md b/apps/docs/docs/tutorials/network-graph.md similarity index 99% rename from apps/docs/docs/use-cases/network-graph.md rename to apps/docs/docs/tutorials/network-graph.md index d33a32497..e9b0dfe92 100644 --- a/apps/docs/docs/use-cases/network-graph.md +++ b/apps/docs/docs/tutorials/network-graph.md @@ -3,7 +3,7 @@ title: Create a Network Graph sidebar_position: 3 --- -Create a developer graph for related groups of projects. New to OSO? Check out our [Getting Started guide](../get-started/index.mdx) to set up your BigQuery or API access. +Create a developer graph for related groups of projects. New to OSO? Check out our [Getting Started guide](../get-started/index.md) to set up your BigQuery or API access. This tutorial combines various datasets to create a developer contribution graph. The graph highlights developers who have contributed to relevant repositories with onchain activity and shows their interactions with other (mostly off-chain) repositories. The analysis objective is to identify core developers contributing to specific projects and track their interactions with other repositories. diff --git a/apps/docs/docs/use-cases/network-graph.png b/apps/docs/docs/tutorials/network-graph.png similarity index 100% rename from apps/docs/docs/use-cases/network-graph.png rename to apps/docs/docs/tutorials/network-graph.png diff --git a/apps/docs/docs/use-cases/project-deepdive.md b/apps/docs/docs/tutorials/project-deepdive.md similarity index 98% rename from apps/docs/docs/use-cases/project-deepdive.md rename to apps/docs/docs/tutorials/project-deepdive.md index 15f1cbca7..b4d95bcae 100644 --- a/apps/docs/docs/use-cases/project-deepdive.md +++ b/apps/docs/docs/tutorials/project-deepdive.md @@ -3,7 +3,7 @@ title: Deep Dive into a Project sidebar_position: 2 --- -Analyze detailed metrics for a specific project. New to OSO? Check out our [Getting Started guide](../get-started/index.mdx) to set up your BigQuery or API access. +Analyze detailed metrics for a specific project. New to OSO? Check out our [Getting Started guide](../get-started/index.md) to set up your BigQuery or API access. :::tip All **projects** are defined as YAML files in [OSS Directory](https://github.com/opensource-observer/oss-directory). View our current projects [here](https://github.com/opensource-observer/oss-directory/tree/main/data/projects). @@ -302,4 +302,4 @@ df = client.query(query).to_dataframe() Projects are defined as YAML files in our [OSS Directory repo](https://github.com/opensource-observer/oss-directory). You can add or update your own projects or project artifacts by submitting a pull request. -For more information on how projects work, see our guide [here](../how-oso-works/oss-directory/project.md). +For more information on how projects work, see our guide [here](../guides/oss-directory/project.md). diff --git a/apps/docs/docusaurus.config.ts b/apps/docs/docusaurus.config.ts index 05a581b6e..73fb91ab9 100644 --- a/apps/docs/docusaurus.config.ts +++ b/apps/docs/docusaurus.config.ts @@ -149,16 +149,36 @@ const config: Config = { title: "Docs", items: [ { - label: "Contribute to OSO", - to: "/docs/contribute/", + label: "Get Started", + to: "/docs/get-started/", }, { - label: "Get OSO Data", + label: "Add your project", + to: "/docs/projects/", + }, + { + label: "Get Data", to: "/docs/integrate/", }, { - label: "Learn How OSO Works", - to: "/docs/how-oso-works/", + label: "Tutorials", + to: "/docs/tutorials/", + }, + { + label: "Contribute data", + to: "/docs/contribute-data/", + }, + { + label: "Contribute models", + to: "/docs/contribute-models/", + }, + { + label: "Guides", + to: "/docs/guides/", + }, + { + label: "References", + to: "/docs/references/", }, ], }, diff --git a/apps/docs/package.json b/apps/docs/package.json index 7edea16f4..4c32bd85f 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -27,7 +27,7 @@ "@docusaurus/theme-common": "3.5.2", "@laxels/docusaurus-plugin-segment": "^1.0.6", "@mdx-js/react": "^3.0.1", - "@plasmicapp/react-web": "^0.2.353", + "@plasmicapp/react-web": "^0.2.357", "@plasmicpkgs/plasmic-basic-components": "^0.0.230", "clsx": "^2.1.1", "lodash": "^4.17.21", @@ -42,7 +42,7 @@ "@eslint/compat": "^1.2.0", "@eslint/eslintrc": "^3.1.0", "@eslint/js": "^9.12.0", - "@plasmicapp/cli": "^0.1.331", + "@plasmicapp/cli": "^0.1.334", "dotenv": "^16.4.5", "typescript": "~5.3.3" }, diff --git a/apps/docs/plasmic.json b/apps/docs/plasmic.json index 99ff5411d..5dd6afbf3 100644 --- a/apps/docs/plasmic.json +++ b/apps/docs/plasmic.json @@ -182,6 +182,6 @@ ] }, "wrapPagesWithGlobalContexts": true, - "cliVersion": "0.1.331", - "$schema": "https://unpkg.com/@plasmicapp/cli@0.1.331/dist/plasmic.schema.json" + "cliVersion": "0.1.334", + "$schema": "https://unpkg.com/@plasmicapp/cli@0.1.334/dist/plasmic.schema.json" } diff --git a/apps/docs/plasmic.lock b/apps/docs/plasmic.lock index cc15f41d0..83cd640a0 100644 --- a/apps/docs/plasmic.lock +++ b/apps/docs/plasmic.lock @@ -16,32 +16,32 @@ { "type": "renderModule", "assetId": "z50hW5Ihi9k5", - "checksum": "b31d1641507048ab4f7055d8761bbc72" + "checksum": "3be61d65c8defd07b3d8ecf8dc8cc4fc" }, { "type": "cssRules", "assetId": "z50hW5Ihi9k5", - "checksum": "b31d1641507048ab4f7055d8761bbc72" + "checksum": "3be61d65c8defd07b3d8ecf8dc8cc4fc" }, { "type": "renderModule", "assetId": "8u0yNVg3vXsq", - "checksum": "3666ca99b526dec75ce5ee1ba21e7ae3" + "checksum": "e0dad1fe31d8464ea45e3b4dc622e794" }, { "type": "cssRules", "assetId": "8u0yNVg3vXsq", - "checksum": "3666ca99b526dec75ce5ee1ba21e7ae3" + "checksum": "e0dad1fe31d8464ea45e3b4dc622e794" }, { "type": "renderModule", "assetId": "XdMR0R8lmSdz", - "checksum": "b9d1c3f20d78e5fb383ad3c43e54c707" + "checksum": "ac4292336ed08e840b89012feb43944d" }, { "type": "cssRules", "assetId": "XdMR0R8lmSdz", - "checksum": "b9d1c3f20d78e5fb383ad3c43e54c707" + "checksum": "ac4292336ed08e840b89012feb43944d" }, { "type": "icon", @@ -66,7 +66,7 @@ { "assetId": "2CtczDeUz9jL9qnFi6NWuQ", "type": "projectCss", - "checksum": "ca22df23535ee01348fd2e1587fefcbb" + "checksum": "576612e0453bec6db6346c326e38e4d7" } ], "codegenVersion": "0.0.1" @@ -80,7 +80,7 @@ { "assetId": "caTPwKxj5ZrD9LQ7DMdK4Z", "type": "projectCss", - "checksum": "e1ec850476829c38b0f9b6d4f7ac446a" + "checksum": "1c02168c6b23256606111fdfdbb63549" } ], "codegenVersion": "0.0.1" diff --git a/apps/docs/src/components/BlogTagsPostsPage.tsx b/apps/docs/src/components/BlogTagsPostsPage.tsx index d3e5acb3c..0b4886e81 100644 --- a/apps/docs/src/components/BlogTagsPostsPage.tsx +++ b/apps/docs/src/components/BlogTagsPostsPage.tsx @@ -17,7 +17,7 @@ import Heading from "@theme/Heading"; function BlogTagsPostsPageMetadata({ tag }: Props): JSX.Element { const title = _.capitalize(tag.label); - console.log(tag); + //console.log(tag); return ( <> diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 6aa4730b7..94bf54a44 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -46,11 +46,11 @@ importers: specifier: ^3.0.1 version: 3.0.1(@types/react@18.3.11)(react@18.3.1) '@plasmicapp/react-web': - specifier: ^0.2.353 - version: 0.2.353(@types/react@18.3.11)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + specifier: ^0.2.357 + version: 0.2.357(@types/react@18.3.11)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) '@plasmicpkgs/plasmic-basic-components': specifier: ^0.0.230 - version: 0.0.230(@plasmicapp/host@1.0.207(react-dom@18.3.1(react@18.3.1))(react@18.3.1))(@plasmicapp/query@0.1.79(react@18.3.1))(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + version: 0.0.230(@plasmicapp/host@1.0.208(react-dom@18.3.1(react@18.3.1))(react@18.3.1))(@plasmicapp/query@0.1.79(react@18.3.1))(react-dom@18.3.1(react@18.3.1))(react@18.3.1) clsx: specifier: ^2.1.1 version: 2.1.1 @@ -86,8 +86,8 @@ importers: specifier: ^9.12.0 version: 9.12.0 '@plasmicapp/cli': - specifier: ^0.1.331 - version: 0.1.331 + specifier: ^0.1.334 + version: 0.1.334 dotenv: specifier: ^16.4.5 version: 16.4.5 @@ -3349,8 +3349,8 @@ packages: peerDependencies: react: '>=16.8.0' - '@plasmicapp/cli@0.1.331': - resolution: {integrity: sha512-7zciU9An9TOe007u22lKr3dNdd+kjNkii7Vr08kV1pbJlmUajRdh31vFWOLyVZUst/4T2AmK3o2X3gbiZDi4Gw==} + '@plasmicapp/cli@0.1.334': + resolution: {integrity: sha512-ZPliBIW6Q3s2VuPxSseDzJSReUyFKRBc64PtdbIrKgxuwPE5ewciPw2KpJe8Hdl6g1cmS/aE5EingW0ueHI78g==} engines: {node: '>=12'} hasBin: true @@ -3360,8 +3360,8 @@ packages: peerDependencies: react: '>=16.8.0' - '@plasmicapp/data-sources@0.1.166': - resolution: {integrity: sha512-sw2oziZA87CW7yQcmxjIt5wDA8IAeoF8bJTSNvPMzGb4tq1Nlu5Fztzj/nQw9d1vQwEOpP49BjvAPe/E7YV9Kw==} + '@plasmicapp/data-sources@0.1.167': + resolution: {integrity: sha512-Z6xQhjBcMBPdUuFn4YwXtrn/T3/WSS2i8b3JkdSpndinA+/IV80rAJcDVdB/waJkq5dH/uS3uRNc0vr7xzGJEw==} engines: {node: '>=10'} peerDependencies: react: '>=16.8.0' @@ -3372,8 +3372,8 @@ packages: react: '>=16.8.0' react-dom: '>=16.8.0' - '@plasmicapp/host@1.0.207': - resolution: {integrity: sha512-3Tb+BKB7rXJTMziQe1vxhmmNz8K2BTHK5cX/pb37oiTqrGJUYaOyXGB0f5u4+jwqRfGcCFrBa5POOgwJvDcOUQ==} + '@plasmicapp/host@1.0.208': + resolution: {integrity: sha512-zJqehUKlw2E5d/IVxoGTeENnnPimyPG9n7LRdh4eL0phtSU/X7XKHR7qfovb7XgFkoZhLf16HP0Z0uOnAMsMwg==} peerDependencies: react: '>=16.8.0' react-dom: '>=16.8.0' @@ -3420,8 +3420,8 @@ packages: react: '>=16.8.0' react-dom: '>=16.8.0' - '@plasmicapp/nextjs-app-router@1.0.12': - resolution: {integrity: sha512-D3h90ie5eTCiaSEHoUumu/dJEgw+O7E+P1mZBqwj2QIETIWFhqa7lQAh4c4IlJEyqpLJd3Yvzsdsp2IamW/lmQ==} + '@plasmicapp/nextjs-app-router@1.0.14': + resolution: {integrity: sha512-c5734xbpOpMs6LgJzmyWAOBvPbelquNBUBrPvat8wnD6NsnYfW6x+JwOvAAo2W4VvjCEqYOgdAHqNV7xSBk1eg==} engines: {node: '>=16'} hasBin: true peerDependencies: @@ -3435,6 +3435,13 @@ packages: react: '>=16.8.0' react-dom: '>=16.8.0' + '@plasmicapp/prepass@1.0.19': + resolution: {integrity: sha512-In8NIXotocOAVDZismfBzOxJnoHaQEKFDPGfr2VuVQ4z8cZ8S/MtccLXJLQe+bJPD0nOG4ZC8lyJOvq4KLbflg==} + engines: {node: '>=12'} + peerDependencies: + react: '>=16.8.0' + react-dom: '>=16.8.0' + '@plasmicapp/query@0.1.79': resolution: {integrity: sha512-EdjQkvsMoFRoiaalMg1iithfUJCgH0nfSeRXp/nPBuYL9LeW4ueJbimkRWsJPHWxgnb+92MTG3WQWtkstQEdxw==} engines: {node: '>=10'} @@ -3446,8 +3453,13 @@ packages: peerDependencies: react: ^16.8.0 || ^17.0.0 || ^18.0.0 - '@plasmicapp/react-web@0.2.353': - resolution: {integrity: sha512-ps01CXWCQWAo5GuvaUmZAe/kKFMCLbEMpR5BPF6Y3agDgP1Cg35n3pjkc2kU+7GZ/8eJPBclIROrouIGvxcucA==} + '@plasmicapp/react-ssr-prepass@2.0.9': + resolution: {integrity: sha512-HO932uH/Y4otaDmjwzJbCLlokxNAdtU9VhDVUZUuVbzh0DhWaNyn/MINCu1oeZ4a6MIjdXFIm/U2VaxNxHYdsw==} + peerDependencies: + react: ^16.8.0 || ^17.0.0 || ^18.0.0 + + '@plasmicapp/react-web@0.2.357': + resolution: {integrity: sha512-OPtJQHGIefZu8FHFDUu4NObpRHl4E4CAmaoc+5i3XiSjNG4B3ce2NdGhNyDh7o8KbtpyxGilc+/Xvih+08WVCQ==} peerDependencies: react: '>=16.8.0' react-dom: '>=16.8.0' @@ -17873,16 +17885,16 @@ snapshots: '@plasmicapp/query': 0.1.79(react@18.3.1) react: 18.3.1 - '@plasmicapp/cli@0.1.331': {} + '@plasmicapp/cli@0.1.334': {} '@plasmicapp/data-sources-context@0.1.21(react@18.3.1)': dependencies: react: 18.3.1 - '@plasmicapp/data-sources@0.1.166(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': + '@plasmicapp/data-sources@0.1.167(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': dependencies: '@plasmicapp/data-sources-context': 0.1.21(react@18.3.1) - '@plasmicapp/host': 1.0.207(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + '@plasmicapp/host': 1.0.208(react-dom@18.3.1(react@18.3.1))(react@18.3.1) '@plasmicapp/isomorphic-unfetch': 1.0.3 '@plasmicapp/query': 0.1.79(react@18.3.1) fast-stringify: 2.0.0 @@ -17898,7 +17910,7 @@ snapshots: react-dom: 18.3.1(react@18.3.1) window-or-global: 1.0.1 - '@plasmicapp/host@1.0.207(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': + '@plasmicapp/host@1.0.208(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': dependencies: '@plasmicapp/query': 0.1.79(react@18.3.1) csstype: 3.1.3 @@ -17968,11 +17980,11 @@ snapshots: react-dom: 18.3.1(react@18.3.1) yargs: 17.7.2 - '@plasmicapp/nextjs-app-router@1.0.12(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': + '@plasmicapp/nextjs-app-router@1.0.14(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': dependencies: - '@plasmicapp/prepass': 1.0.17(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + '@plasmicapp/prepass': 1.0.19(react-dom@18.3.1(react@18.3.1))(react@18.3.1) '@plasmicapp/query': 0.1.79(react@18.3.1) - cross-spawn: 7.0.3 + cross-spawn: 7.0.6 fkill: 8.1.1 get-port: 7.1.0 node-html-parser: 6.1.13 @@ -17987,6 +17999,13 @@ snapshots: react: 18.3.1 react-dom: 18.3.1(react@18.3.1) + '@plasmicapp/prepass@1.0.19(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': + dependencies: + '@plasmicapp/query': 0.1.79(react@18.3.1) + '@plasmicapp/react-ssr-prepass': 2.0.9(react@18.3.1) + react: 18.3.1 + react-dom: 18.3.1(react@18.3.1) + '@plasmicapp/query@0.1.79(react@18.3.1)': dependencies: react: 18.3.1 @@ -17996,15 +18015,19 @@ snapshots: dependencies: react: 18.3.1 - '@plasmicapp/react-web@0.2.353(@types/react@18.3.11)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': + '@plasmicapp/react-ssr-prepass@2.0.9(react@18.3.1)': + dependencies: + react: 18.3.1 + + '@plasmicapp/react-web@0.2.357(@types/react@18.3.11)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': dependencies: '@plasmicapp/auth-react': 0.0.22(react@18.3.1) - '@plasmicapp/data-sources': 0.1.166(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + '@plasmicapp/data-sources': 0.1.167(react-dom@18.3.1(react@18.3.1))(react@18.3.1) '@plasmicapp/data-sources-context': 0.1.21(react@18.3.1) - '@plasmicapp/host': 1.0.207(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + '@plasmicapp/host': 1.0.208(react-dom@18.3.1(react@18.3.1))(react@18.3.1) '@plasmicapp/loader-splits': 1.0.62 - '@plasmicapp/nextjs-app-router': 1.0.12(react-dom@18.3.1(react@18.3.1))(react@18.3.1) - '@plasmicapp/prepass': 1.0.17(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + '@plasmicapp/nextjs-app-router': 1.0.14(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + '@plasmicapp/prepass': 1.0.19(react-dom@18.3.1(react@18.3.1))(react@18.3.1) '@plasmicapp/query': 0.1.79(react@18.3.1) '@react-aria/checkbox': 3.14.3(react@18.3.1) '@react-aria/focus': 3.17.1(react@18.3.1) @@ -18042,9 +18065,9 @@ snapshots: - supports-color - utf-8-validate - '@plasmicpkgs/plasmic-basic-components@0.0.230(@plasmicapp/host@1.0.207(react-dom@18.3.1(react@18.3.1))(react@18.3.1))(@plasmicapp/query@0.1.79(react@18.3.1))(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': + '@plasmicpkgs/plasmic-basic-components@0.0.230(@plasmicapp/host@1.0.208(react-dom@18.3.1(react@18.3.1))(react@18.3.1))(@plasmicapp/query@0.1.79(react@18.3.1))(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': dependencies: - '@plasmicapp/host': 1.0.207(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + '@plasmicapp/host': 1.0.208(react-dom@18.3.1(react@18.3.1))(react@18.3.1) '@plasmicapp/query': 0.1.79(react@18.3.1) react: 18.3.1 react-dom: 18.3.1(react@18.3.1) @@ -21770,7 +21793,6 @@ snapshots: path-key: 3.1.1 shebang-command: 2.0.0 which: 2.0.2 - optional: true crypto-random-string@2.0.0: {} @@ -23116,7 +23138,7 @@ snapshots: execa@5.1.1: dependencies: - cross-spawn: 7.0.3 + cross-spawn: 7.0.6 get-stream: 6.0.1 human-signals: 2.1.0 is-stream: 2.0.1 diff --git a/warehouse/dbt/models/homepage.md b/warehouse/dbt/models/homepage.md index d0aabd9e5..254e8fb84 100644 --- a/warehouse/dbt/models/homepage.md +++ b/warehouse/dbt/models/homepage.md @@ -23,7 +23,7 @@ Note that you can also right-click on models to interactively filter and explore - [Website](https://www.opensource.observer/) - [Documentation](https://docs.opensource.observer/) -- [Technical architecture](https://docs.opensource.observer/docs/how-oso-works/architecture) +- [Technical architecture](https://docs.opensource.observer/docs/guides/architecture) - [GitHub repo](https://github.com/opensource-observer/oso) - [Dagster dashboard](https://dagster.opensource.observer/)