Skip to content

new version of nav #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
470 changes: 231 additions & 239 deletions docs.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions get-started/exploring-data/intro-metrics-dimensions.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "An intro to metrics and dimensions"
sidebarTitle: Metrics and dimensions
---

## What are metrics and dimensions?
Expand Down
2 changes: 1 addition & 1 deletion get-started/exploring-data/sharing-insights.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Share insights with your team"
title: "Sharing with your team"
description: It's time to share your hard work with the world!
---

Expand Down
2 changes: 2 additions & 0 deletions get-started/exploring-data/using-explores.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Using Tables and the Explore view"
sidebarTitle: Query from tables

---

Now that you've connected your dbt project to Lightdash, it's time to start exploring your data.
Expand Down
1 change: 1 addition & 0 deletions guides/how-to-embed-content.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "How to embed content"
sidebarTitle: Embedding quickstart
description: Lightdash allows you to embed your dashboards using expirable URLs and tokens (embed URLs from now on). This is a great way to enable self-serve analytics in your own application and platform by leveraging the insights you've got in Lightdash and making them available to your own users.
---

Expand Down
233 changes: 233 additions & 0 deletions old_nav.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,233 @@
{
"tab": "Docs",
"groups": [
{
"group": "Getting started tutorials",
"pages": [
"get-started/intro",
{
"group": "Setting up a new project",
"pages": [
"get-started/setup-lightdash/intro",
"get-started/setup-lightdash/get-project-lightdash-ready",
"get-started/setup-lightdash/connect-project",
"get-started/setup-lightdash/intro-metrics-dimensions",
"get-started/setup-lightdash/using-explores",
"get-started/setup-lightdash/how-to-create-metrics",
"get-started/setup-lightdash/invite-new-users",
"get-started/setup-lightdash/sharing-insights"
]
},
{
"group": "Developing in Lightdash",
"pages": [
"get-started/develop-in-lightdash/intro",
"get-started/develop-in-lightdash/exploring-your-content",
"get-started/develop-in-lightdash/intro-metrics-dimensions",
"get-started/develop-in-lightdash/using-explores",
"get-started/develop-in-lightdash/how-to-create-dimensions",
"get-started/develop-in-lightdash/how-to-create-metrics",
"get-started/develop-in-lightdash/sharing-insights"

]
},
{
"group": "Learning to explore data in Lightdash",
"pages": [
"get-started/exploring-data/intro",
"get-started/exploring-data/exploring-your-content",
"get-started/exploring-data/intro-metrics-dimensions",
"get-started/exploring-data/using-explores",
"get-started/exploring-data/sharing-insights",
"get-started/exploring-data/dashboards"
]
}
]
},
{
"group": "Guides",
"pages": [
{
"group": "Exploring Data in Lightdash",
"pages": [
"guides/ai-agents",
"guides/metrics-catalog",
"guides/limiting-data-using-filters",
"guides/interactive-dashboards",
"guides/pinning",
"guides/using-slack-integration",
"guides/how-to-create-scheduled-deliveries",
"guides/how-to-create-alerts",
"guides/version-history",
"guides/formatting-your-fields",
{
"group": "Table calculation SQL templates",
"pages": [
"guides/table-calculations/sql-templates",
"guides/table-calculations/table-calculation-sql-templates/percent-change-from-previous",
"guides/table-calculations/table-calculation-sql-templates/percent-of-previous-value",
"guides/table-calculations/table-calculation-sql-templates/percent-of-total-column",
"guides/table-calculations/table-calculation-sql-templates/percent-of-group-pivot-total",
"guides/table-calculations/table-calculation-sql-templates/rank-in-column",
"guides/table-calculations/table-calculation-sql-templates/running-total",
"guides/table-calculations/table-calculation-sql-templates/rolling-window"
]
}
]
},
{
"group": "Developing in Lightdash",
"pages": [
"guides/lightdash-semantic-layer",
"guides/adding-tables-to-lightdash",
"guides/how-to-create-dimensions",
"guides/how-to-create-metrics",
"guides/how-to-join-tables",
"guides/filtering-dashboard-in-url",
"guides/vs-code-yaml-validation",
"guides/how-to-promote-content",
"guides/renaming-models-and-fields"
]
},
{
"group": "Using the Lightdash CLI",
"pages": [
"guides/cli/intro",
"guides/cli/how-to-install-the-lightdash-cli",
"guides/cli/cli-authentication",
"guides/cli/how-to-upgrade-cli",
"guides/cli/how-to-auto-generate-schema-files",
"guides/cli/how-to-use-lightdash-preview",
"guides/cli/how-to-use-lightdash-deploy",
"guides/cli/how-to-compile-your-lightdash-project",
"guides/cli/how-to-use-lightdash-validate"
]
},
{
"group": "Managing your Organization",
"pages": [
"guides/adding-slack-integration",
"guides/how-to-create-multiple-projects",
"guides/customizing-the-appearance-of-your-project"
]
},
"guides/how-to-embed-content"
]
},
{
"group": "References",
"pages": [
"references/references",
{
"group": "Lightdash Development",
"pages": [
"references/develop",
"references/dimensions",
"references/metrics",
"references/tables",
"references/joins",
"references/preview-projects",
"references/validating-your-content",
{
"group": "SQL Runner",
"pages": [
"references/sql-runner",
"references/virtual-views",
"references/dbt-write-back"
]
},
"references/dbt-write-back",
"references/dashboards-as-code",
"references/sql-variables",
"references/caching"
]
},
{
"group": "Data Exploration",
"pages": [
"references/explore",
"references/spaces",
"get-started/exploring-data/dashboards",
"references/chart-types",
"references/filters",
"references/table-calculations",
"references/custom-fields",
"references/custom-tooltip",
"references/custom-charts"
]
},
"references/lightdash-cli",
{
"group": "Integrations",
"pages": [
"references/integrations",
"references/dbt-projects",
"references/slack-integration",
"references/google-sheets"
]
},
{
"group": "Admin",
"pages": [
"references/admin",
"references/usage-analytics",
"references/roles",
"references/groups",
"references/user-attributes",
"references/scim-integration"
]
},
{
"group": "User",
"pages": [
"references/user",
"references/personal_tokens"
]
},
{
"group": "Embedding",
"pages": [
"references/embedding",
"references/react-sdk"
]
}
]
},
{
"group": "Self-hosting",
"pages": [
"self-host/self-host-lightdash",
"self-host/lightdash-cloud-vs-self-hosted",
"self-host/self-host-lightdash-docker-compose",
"self-host/self-host-lightdash-restack",
"self-host/update-lightdash",
{
"group": "Customize deployment",
"pages": [
"self-host/customize-deployment/configure-a-slack-app-for-lightdash",
"self-host/customize-deployment/configure-github-for-lightdash",
"self-host/customize-deployment/configure-lightdash-to-use-an-external-database",
"self-host/customize-deployment/configure-lightdash-to-use-external-object-storage",
"self-host/customize-deployment/configure-logging-for-lightdash",
"self-host/customize-deployment/configure-smtp-for-lightdash-email-notifications",
"self-host/customize-deployment/configure-standalone-scheduled-worker",
"self-host/customize-deployment/enable-headless-browser-for-lightdash",
"self-host/customize-deployment/enable-scheduler-in-self-hosted-lightdash",
"self-host/customize-deployment/environment-variables",
"self-host/customize-deployment/google-sheets-integration",
"self-host/customize-deployment/recommended-resources",
"self-host/customize-deployment/secure-lightdash-with-https",
"self-host/customize-deployment/use-sso-login-for-self-hosted-lightdash"
]
}
]
},
{
"group": "Contact",
"pages": [
"faqs",
"contact/contact_info"
]
}
]
},
1 change: 1 addition & 0 deletions references/dbt-projects.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "dbt Projects"
sidebarTitle: dbt
description: "You can easily make changes in dbt and see them updated in your Lightdash project."
---

Expand Down
1 change: 1 addition & 0 deletions references/embedding.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Embedding Overview"
sidebarTitle: Embedding reference
description: "You can embed Lightdash content in your website or application securely using Lightdash embedding."
---

Expand Down
3 changes: 2 additions & 1 deletion references/slack-integration.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Slack integration reference"
title: "Slack integration"
sidebarTitle: Slack
description: "Below is everything you need to know about the Lightdash Slack integration."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Add headless browser on self-hosting"
description: "We use a chrome headless browser to generate images from your charts and dashboards so we can send them via email or Slack."
sidebarTitle: Headless browser

---

Images can be requested on `Slack unfurl` or using our `Scheduler`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Configure a Google Sheets integration for self-hosted Lightdash
description: "In this guide we will show you how you can [upload to Google Sheets in scheduled deliveries](/references/google-sheets) and upload results from Google Sheets on `charts` on your on self-hosted Lightdash server."
sidebarTitle: Google sheets
---

### Enable Google SSO
Expand Down
1 change: 1 addition & 0 deletions self-host/self-host-lightdash-docker-compose.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Self-host Lightdash using docker compose"
sidebarTitle: Docker compose
---

This guide will give you a minimal Lightdash instance running on your local machine. It will not be accessible from the internet, but it will be accessible from your local machine. This is a great way to get started with Lightdash for a proof-of-concept without needing access to kubernetes.
Expand Down
1 change: 1 addition & 0 deletions self-host/self-host-lightdash-restack.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Self-Host Lightdash with Restack"
sidebarTitle: Restack
---

Restack is a managed service for deploying and managing open-source software.
Expand Down
1 change: 1 addition & 0 deletions self-host/update-lightdash.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Updating Lightdash to the latest version"
sidebarTitle: Updating Lightdash
---

## Local deployments
Expand Down