Skip to content

Commit

Permalink
chore: Added screen recordings of the dashboard
Browse files Browse the repository at this point in the history
  • Loading branch information
matvp91 committed Oct 21, 2024
1 parent 2133c1d commit 7225909
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 7 deletions.
6 changes: 6 additions & 0 deletions docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,10 @@

.VPHomeHero .VPImage {
max-width: 160px;
}

.video {
border-radius: 12px;
overflow: hidden;
border: 3px solid rgb(60, 60, 67);
}
21 changes: 14 additions & 7 deletions docs/guide/dashboard.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
# Dashboard

The dashboard is a single page application where you can manage a wide variety of functionalities.
The dashboard is a single page application where you can manage a wide variety of functionalities. Typically, you'd want to build the dashboard once and upload it to S3 to serve it as a static site. The dashboard is an SPA and requires no separate server / backend to function.

- Shows pending, running, completed and failed jobs.
- Inspect a job, with logs, sub processes and many more metrics.
- A storage tab that lets you explore the configured S3 bucket. You can see what kind of playlists are generated, what is uploaded to S3, and more.
- Watch API / Stitcher documentation and call API requests directly from within the dashboard.
Verify you've set the correct variables in `config.env`, each env key prefixed with `PUBLIC_` will be available in the dashboard and will be included in the final Javascript bundle.

Typically, you'd want to build the dashboard once and upload it to S3 to serve it as a static site. The dashboard is an SPA and requires no separate server / backend to function.
Show pending, running, completed and failed jobs. You can easily inspect a job, with logs, sub processes and other metrics.

Verify you've set the correct variables in `config.env`, each env key prefixed with `PUBLIC_` will be available in the dashboard and will be included in the final Javascript bundle.
<video class="video" muted autoplay controls src="/dashboard-jobs.mp4"></video>

We've got a neat storage tab that lets you explore the configured S3 bucket, as if it was your local hard disk. There's a preview function that lets you inspect readable files such as playlists (m3u8) and more.

<video class="video" muted autoplay controls src="/dashboard-storage.mp4"></video>

A playground for the Stitcher, where you can throw any configuration at it and it'll create a session for you. We've got our player embedded on the right for instant preview.

<video class="video" muted autoplay controls src="/dashboard-stitcher.mp4"></video>

But wait, there's more! We have a page dedicated to the API and the Sticher API. You can read through the Swagger documentation and fire API calls right away. The dashboard is all you need to get started quickly.
6 changes: 6 additions & 0 deletions docs/guide/what-is-superstreamer.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ There are plenty of great video tools out there, but we saw a gap — a unified
Can't wait? Head over to our [Getting Started](/guide/getting-started) page and jump right into it!
:::

::: tip

Check out these cool screen recordings of the dashboard app! Click <a target="_blank" href="/superstreamer/guide/dashboard">here</a> to view them. The link will open in a new tab, so you won't lose your place.

:::

## Developer Experience

- **Simplified workflow**
Expand Down
Binary file added docs/public/dashboard-jobs.mp4
Binary file not shown.
Binary file added docs/public/dashboard-stitcher.mp4
Binary file not shown.
Binary file added docs/public/dashboard-storage.mp4
Binary file not shown.

0 comments on commit 7225909

Please sign in to comment.