Skip to content

Commit

Permalink
docs: add an FAQ (#2358)
Browse files Browse the repository at this point in the history
- Just a few questions to start, we can always add more later
  • Loading branch information
ryscheng authored Oct 16, 2024
1 parent 8a6ed0a commit 2f5c9e2
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 7 deletions.
86 changes: 86 additions & 0 deletions apps/docs/docs/references/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
---
title: FAQ
sidebar_position: 5
---

## Community

### 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 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,
we need to live by an open source ethos.
We are supported by grants from our generous partners, which pay for
the platform development, running the data pipeline regularly,
and community incentives for data and insights.
If you want to support us, please reach out at
[[email protected]](mailto:[email protected]).

### I'm brand new. How do I get started?

Join our [Discord](https://www.opensource.observer/discord).
This is where we hang out most of the time and usually the best place
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)
if you're looking for more structure.

---

## Data

### How can we analyze different open source ecosystems?

Our ambition with OSO is to transform how we measure impact
across _any_ open source ecosystem.
However, you'll notice that most of our existing data
is skewed towards certain ecosystems that we work with closely.
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).

### How often do you index / refresh your data?

Our data pipeline currently is set to run weekly (on Sundays).
Our existing setup involves large jobs that take days to complete.
We are working on optimizing our performance and cost structure
so that we can run this more frequently.

---

## Product

### How can I request a new feature?

We live and breathe in our
[GitHub issues](https://github.com/opensource-observer/oso/issues/).
In order to help us triage, please search to see if an existing issue
already exists for your request before filing a new issue.
You can monitor our progress on our
[project board](https://github.com/orgs/opensource-observer/projects/3/views/10).

### How is OSO different from XYZ tool?

What distinguishes OSO is the power of our community,
where every part of our stack is supported by a diverse network of contributors, including:

- data indexers who provide various raw data sources
- data modelers who help us refine our metrics and data models
- data engineers who keep the pipeline running smoothly
- data integrations that share OSO metrics and insights across various applications

Together, we are building a rich dependency tree of open data sets,
which you can see on our
[Dagster dashboard](https://dagster.opensource.observer/assets).
Every data asset is maintained by a dedicated contributor and refreshed regularly.
Each contributor has their own upstream dependencies and downstream dependents.
New contributors can build on any existing data asset, including hundreds
of incredible intermediate models, from user reputation models to retention/churn models.
We are building the biggest data network with the best open source community.
14 changes: 7 additions & 7 deletions apps/docs/docs/references/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,6 @@ title: References
sidebar_position: 1
---

## Data Model Reference Documentation

[https://models.opensource.observer](https://models.opensource.observer/)

These are the auto-generated dbt docs for each model
in `warehouse/dbt/models/`.

## Dagster dashboard

[https://dagster.opensource.observer](https://dagster.opensource.observer)
Expand All @@ -19,3 +12,10 @@ as well as the current status of every stage of the pipeline.

Admins can trigger runs
[here](https://admin-dagster.opensource.observer/)

## Data Model Reference Documentation

[https://models.opensource.observer](https://models.opensource.observer/)

These are the auto-generated dbt docs for each model
in `warehouse/dbt/models/`.

0 comments on commit 2f5c9e2

Please sign in to comment.