Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
rephus committed Dec 4, 2024
0 parents commit 75adcba
Show file tree
Hide file tree
Showing 526 changed files with 43,601 additions and 0 deletions.
Empty file.
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# dependencies
node_modules
/.pnp
.pnp.js

# misc
.DS_Store
.idea

# docs
/build
/.docusaurus
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
20.8.0
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

## Installation

```console
yarn install
```

## Local Development

```console
yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## Build

```console
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

```console
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
3 changes: 3 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
Binary file added docs/assets/demo_lightdash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
87 changes: 87 additions & 0 deletions docs/best-practice/lightdash-way.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
sidebar_position: 1
sidebar_label: The Lightdash Way for data access
---

# The Lightdash Way: Data Access

Our mission at Lightdash is:

> To enable everybody in your company to answer their own questions using data.
Lightdash is where the data team (👷‍♀️ the builders) and the rest of the business (👩‍🌾 the
consumers) come together to make better data-driven decisions.

We have some pretty strong opinions about how this relationship between data builders
and data consumers should work. So, we thought it would be useful to explain the
principles that make up The Lightdash Way.

The Lightdash Way isn't just semantics (😏) - it's about the entire experience of
enabling everybody in your company to answer their own data questions. But, we'll start
off slow and just go through one of the principles for now:

> How should you serve data to people who want to answer their own data questions?
**⚡️ The Lightdash Way:**

**Give end users meaningful building blocks to answer their own data questions.**

Let me explain what we mean...

## We've come across three ways to let people answer their questions using data:

_I hope it's obvious which one is our fave_ 😇

1. You give everyone access to the raw data.
2. If you have a data question, you ask the data builders, and they just give you complete answers.

**⚡ The Lightdash Way:**

3. The data builders give you meaningful building blocks to answer your own data questions.

### 1. You give everyone access to the raw data. 🤪

If everybody in your organization knows SQL and everyone has the context they need to query
the raw data (...and unicorns were real 🦄...), then giving everyone access to the raw data
wouldn't be that bad.

But, if a single person doesn't know SQL then they're totally dependent on someone helping
them with a data question...no bueno.

- 👍: very flexible, totally self-serve (as long as everyone knows SQL)
- 👎: everybody has to know sql, everybody needs context of raw data, duplicated work,
bound to be errors

### 2. If you have a data question, you ask the data builders, and they just give you complete answers. 🎁

If nobody knows SQL or they aren't willing to explore data themselves, then dedicated team
members (probably data analysts) will be completely responsible for exploring data. Everybody
relies on the data team for answer questions.

- 👍: only analysts have to have data skills, fewer errors (since only data experts are answering data questions)
- 👎: doesn't scale, analysts become a bottleneck, this kind of work sort of sucks :(

### 3. The data builders give you meaningful building blocks to answer your own data questions. 🧱

**⚡ The Lightdash Way:** We give your data team the tools they need to build metrics + dimensions
that everyone else can use in a user-friendly interface.

With this approach, you leave the SQL to the experts: your data team. They become force-multipliers
when they create these pre-defined metrics + dimensions in SQL because anybody in the business can
combine, segment, and filter them to answer their own questions.

The downside is that the data team need to spend some time defining and maintaining the library of metrics. But,
a small set of metrics can power a huge amount of different analyses, enabling the rest of your team to answer
their own data questions.

- 👍: you only need a few SQL experts, anyone can ask questions using the data, fewer errors, scaleable
- 👎: you need a data team, this system needs maintenance

## When we aggregate data, we add value.

Giving data consumers useful building blocks makes it easier for them to self-serve and answer
their own questions.

We believe that this way of sharing data insights is a core part of the experience of everyone being able
to answer their own data questions. It's the foundation of a healthy, happy relationship between data builders
and data consumers 👯‍♀️.
51 changes: 51 additions & 0 deletions docs/best-practice/planning-your-dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
sidebar_position: 2
sidebar_label: Planning your dashboard - the Who, What and How of dashboard building.
---

# Planning your dashboard: the Who, What and How of building great dashboards.

For those of you who are just getting started with building dashboards, it it can be useful to do some planning before you get your hands dirty and actually start building the thing.

So, we thought we'd give you a few tips to help you get comfortable with planning your dashboard build. Specifically, we're going to answer three questions before we build our dashboard: “who? what? and how?”

Check out our 5 minute video tutorial here:

[![tutorial planning your dashboard](./assets/tutorial_planning_your_dashboard.png)](https://www.youtube.com/watch?v=g2-dkJkZjiI)

## Before you start building your dashboard, you should be able to answer three questions:

1. [**_Who_ is this dashboard for?**](#who-is-this-dashboard-for)
2. [**_What_ is this dashboard trying to accomplish?**](#what-is-this-dashboard-trying-to-accomplish)
3. [**_How_ can I build this dashboard?**](#how-can-i-build-this-dashboard)

### 1. Who is this dashboard for?

- Does your audience already know what you're talking about?
- Do you need to add more context to help make your point?

**Actions**:

- Think about what context your audience will need and add this to your dashboard. For example, any acronyms that will need clarifying or if an increase in a number is a good or bad thing.

### 2. What is this dashboard trying to accomplish?

- Once your audience has seen the dashboard, do you want them to:
1. take an **_action_**?
2. **_know_** something they didn't know before?
- What information do they need to take an action/be informed?

**Actions:**

- Write out a clear summary of your dashboard's purpose (and add it to your dashboard's description!)
- Write an outline of the questions you want answered in your dashboard's tiles. Start thinking about the story you're trying to tell to your audience.

### 3. How can I build this dashboard?

- What data do I have?
- How can I use it to make my point?

**Actions:**

- Match datasets to the outline of questions you made in the step above.
- Think about which metrics + dimensions you'll use to make your points (and if these exist yet)
4 changes: 4 additions & 0 deletions docs/contact/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Contact",
"position": 2
}
Binary file added docs/contact/assets/star_github_action.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions docs/contact/contact_info.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
sidebar_position: 2
---

# Contact Us

There are a few ways you can get in touch with the team. Here's which one to use depending on your situation:

## I want to report a bug or submit a feature request

Woo, thanks for helping out! You can [create a new issue in GitHub](https://github.com/lightdash/lightdash/issues) and the team will get back to you ASAP 🙂

## I want to give some feedback on the product

There are a two ways you can give us feedback:

1. Creating a [new issue on GitHub](https://github.com/lightdash/lightdash/issues)
2. Sending an email to [email protected]

## I just want to follow along and hear what you're up to

Well, that's nice 😊

There are four things you can do to keep up with all things Lightdash:

1. Join the [Lightdash Community Slack](https://join.slack.com/t/lightdash-community/shared_invite/zt-2ehqnrvqt-LbCq7cUSFHAzEj_wMuxg4A).

2. Star our [GitHub repo](https://github.com/lightdash/lightdash)

![star github action](./assets/star_github_action.png)

3. [Sign up to our newsletter](https://www.lightdash.com/#wf-form-email-form) at the bottom of the home page (we send out regular updates of all the fun things we've been up to!)

4. Join in on the fun in [#tools-lightdash](https://getdbt.slack.com/archives/C026WJE4A69) in dbt's Slack space.

If you're not already a member of dbt's Slack, you can [join the community here](https://www.getdbt.com/community/join-the-community). Once you're in, join us in [#tools-lightdash](https://getdbt.slack.com/archives/C026WJE4A69).

## I'm having problems setting up or using Lightdash

We get it, repeated `error` messages can cause [rage clicking](https://www.fullstory.com/blog/rage-clicks-turn-analytics-into-actionable-insights/), and rage clicking is not a happy place to be.

So, we're here to help.

First, [check out our FAQs](https://github.com/lightdash/lightdash/discussions/categories/q-a) to see if someone has found a solution to your problem already.

If you can't find your answer there, the best ways to reach us are:

1. Post your question [in our Slack Community](https://join.slack.com/t/lightdash-community/shared_invite/zt-2ehqnrvqt-LbCq7cUSFHAzEj_wMuxg4A)
2. Send us a message in the Lightdash app (click on the question mark icon in the navigation bar)
3. Post a [question in our Q&A](https://github.com/lightdash/lightdash/discussions/categories/q-a)
4. [Create a new GitHub issue](https://github.com/lightdash/lightdash/issues) (if it's a bug)
5. Send us an email at [email protected]
4 changes: 4 additions & 0 deletions docs/get-started/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Get started",
"position": 2
}
Binary file added docs/get-started/assets/oauth-scope.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import ExploringYourContent from './../../snippets/exploring-your-content.mdx';

# Exploring your content

<ExploringYourContent />
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import HowToCreateDimensions from './../../snippets/how-to-create-dimensions.mdx';

# How to create dimensions

<HowToCreateDimensions />
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import HowToCreateMetrics from './../../snippets/how-to-create-metrics.mdx';

# How to create metrics

<HowToCreateMetrics />
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import IntroMetricsDimensions from './../../snippets/intro-metrics-dimensions.mdx';

# An intro to metrics and dimensions

<IntroMetricsDimensions />
16 changes: 16 additions & 0 deletions docs/get-started/develop-in-lightdash/intro.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# 👩‍💻 Developing in Lightdash

This tutorial is for people who are new to Lightdash and would like to develop their existing Lightdash project. We'll go over how to use Tables and the Explore view, how to develop Tables in your project, adding your first metrics, and some more advanced configurations for your Lightdash project's content.

1. [Exploring your content](/get-started/develop-in-lightdash/exploring-your-content)
2. [An intro to metrics and dimensions](/get-started/develop-in-lightdash/intro-metrics-dimensions)
3. [Using Tables and the Explore view](/get-started/develop-in-lightdash/using-explores)
4. [Adding dimensions to Lightdash](/get-started/develop-in-lightdash/how-to-create-dimensions)
5. [Adding your first metrics](/get-started/develop-in-lightdash/how-to-create-metrics)
6. [Share insights with your team](/get-started/develop-in-lightdash/sharing-insights)

:::tip

Also check out the [Lightdash Developer Quickstart](https://lightdash.notion.site/Lightdash-developer-quickstart-3192f80173ef4f0bbbe0f0f88b726a76). The quickstart is built in Notion so you can make a copy and follow along, or customize and share with your whole team!

:::
5 changes: 5 additions & 0 deletions docs/get-started/develop-in-lightdash/sharing-insights.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import SharingInsights from './../../snippets/sharing-insights.mdx';

# Share insights with your team

<SharingInsights />
5 changes: 5 additions & 0 deletions docs/get-started/develop-in-lightdash/using-explores.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import UsingExplores from './../../snippets/using-explores.mdx';

# Using Tables and the Explore view

<UsingExplores />
4 changes: 4 additions & 0 deletions docs/get-started/exploring-data/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Explore your data",
"position": 2
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 75adcba

Please sign in to comment.