Skip to content

Commit

Permalink
docs: add shareable dashboard page (formbricks#3188)
Browse files Browse the repository at this point in the history
  • Loading branch information
jobenjada authored Sep 29, 2024
1 parent 59ebde4 commit 68e5295
Show file tree
Hide file tree
Showing 6 changed files with 90 additions and 10 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
75 changes: 75 additions & 0 deletions apps/docs/app/global/shareable-dashboards/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
import { MdxImage } from "@/components/MdxImage";

import StepOne from "./images/1-publish-to-web.webp";
import StepTwo from "./images/2-warning-publish.webp";
import StepThree from "./images/3-share-link.webp";

export const metadata = {
title: "Shareable Dashboards",
description:
"Create shareable links to dashboards of specific surveys.",
};

# Shareable Dashboards

Formbricks allows you to create public, shareable versions of your survey results dashboards. This feature enables you to easily share survey results with stakeholders, team members, or the public without granting access to your Formbricks account.

## How To Publish Survey Results

1. **Go to survey summary**: Choose the survey for which you want to create a shareable dashboard and go to its summary page.

2. **Share results**: Click the "Share results" and then "Publish to web".

<MdxImage
src={StepOne}
alt="Go to survey summary"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>

3. **Confirm**: Click "Publish to public web" (it's public).

<MdxImage
src={StepTwo}
alt="Go to survey summary"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>

4. **Share link**: Formbricks has generated a unique URL for your public dashboard. Share it around.

<MdxImage
src={StepThree}
alt="Go to survey summary"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>

<Note>Whoever has access to the link can access the survey results.</Note>

## How To Unpublish Survey Results

Unpublish is very simple: Go to "Share results" -> "Unpublish from web" -> "Unpublish".

<MdxImage
src={StepThree}
alt="Go to survey summary"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>

## Key Features

- **Read-only access**: Viewers can see survey results but cannot modify data or settings.
- **Real-time updates**: The shared dashboard reflects current survey data in real-time.
- **Filters included**: Visitors can access all filters to dissect the data.
- **Revocable access**: You can disable the shared link at any time to restrict access.

## Use Cases

- Share results with clients or stakeholders
- Publish survey findings to your website or blog
- Collaborate with team members without sharing account credentials
- Create transparency by making certain survey results public

Shareable dashboards provide a simple yet powerful way to disseminate survey insights while maintaining control over your Formbricks account and data.
22 changes: 12 additions & 10 deletions apps/docs/components/ResponsiveVideo.tsx
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
// ResponsiveVideo.js
// ResponsiveVideo.tsx
export const ResponsiveVideo = ({ src, title }) => {
return (
<div className="relative w-full overflow-hidden pt-[56.25%]">
<iframe
src={src}
title={title}
frameBorder="0"
className="absolute left-0 top-0 h-full w-full"
referrerPolicy="strict-origin-when-cross-origin"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowFullScreen></iframe>
<div className="max-w-[1280px]">
<div className="relative w-full overflow-hidden pt-[56.25%]">
<iframe
src={src}
title={title}
frameBorder="0"
className="absolute left-0 top-0 h-full w-full"
referrerPolicy="strict-origin-when-cross-origin"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowFullScreen></iframe>
</div>
</div>
);
};
3 changes: 3 additions & 0 deletions apps/docs/lib/navigation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export const navigation: Array<NavGroup> = [
{ title: "Limit submissions", href: "/global/limit-submissions" }, // global
{ title: "Recall Functionality", href: "/global/recall" }, // global
{ title: "Partial Submissions", href: "/global/partial-submissions" }, // global
{ title: "Shareable Dashboards", href: "/global/shareable-dashboards" },
],
},
],
Expand All @@ -68,6 +69,7 @@ export const navigation: Array<NavGroup> = [
{ title: "Limit submissions", href: "/global/limit-submissions" }, // global
{ title: "Recall Functionality", href: "/global/recall" }, // global
{ title: "Partial Submissions", href: "/global/partial-submissions" }, // global
{ title: "Shareable Dashboards", href: "/global/shareable-dashboards" },
],
},
],
Expand All @@ -91,6 +93,7 @@ export const navigation: Array<NavGroup> = [
{ title: "User Metadata", href: "/global/metadata" },
{ title: "Custom Styling", href: "/global/overwrite-styling" }, // global
{ title: "Conditional Logic", href: "/global/conditional-logic" },
{ title: "Shareable Dashboards", href: "/global/shareable-dashboards" },
{ title: "Start & End Dates", href: "/global/custom-start-end-conditions" },
{ title: "Limit submissions", href: "/global/limit-submissions" }, // global
{ title: "Recall Functionality", href: "/global/recall" },
Expand Down

0 comments on commit 68e5295

Please sign in to comment.