Bump version to v1.0.3-canary.2

Author: markspolakovs

desktop/package.json

@@ -1,7 +1,7 @@
 {
   "name": "badger-desktop",
   "productName": "Badger Desktop",
-  "version": "1.0.3-canary.1",
+  "version": "1.0.3-canary.2",
   "description": "My Electron application description",
   "main": "./out/main/index.js",
   "scripts": {

handbook/.gitignore

@@ -0,0 +1,28 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

handbook/README.md

@@ -0,0 +1,41 @@
+# Badger Handbook
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ 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
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> 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.

handbook/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
+};

handbook/blog/authors.yml

@@ -0,0 +1,5 @@
+markspolakovs:
+  name: Marks Polakovs
+  title: Badger developer
+  url: https://github.com/markspolakovs
+  image_url: https://github.com/markspolakovs.png

handbook/docs/Badger.png

@@ -0,0 +1,14 @@
+---
+sidebar_order: 3
+---
+
+# Data Model
+
+:::warning
+
+This structure may be subject to change.
+Follow issue [BDGR-145](https://github.com/ystv/badger/issues/277) for updates.
+
+:::
+
+Badger's top-level concept is a _show_, which is broken down into _rundowns_ and/or _continuity items_. Rundowns, in turn, have _rundown items_, which can be ether segments or VTs (video tapes, pre-recorded content) as well as _assets_. Both shows and rundowns can also have _metadata_. VTs, continuity items, and assets have _media_ attached.

handbook/docs/data_model.mdx

@@ -0,0 +1,27 @@
+---
+sidebar_position: 1
+---
+
+# Introduction to Badger
+
+Badger is a tool to help with media management and automation for live broadcast.
+
+It provides a web-based tool to set up show rundowns and upload media files, and a desktop app to interface with [OBS](https://obsproject.com/), [vMix](https://www.vmix.com/), and [Ontime](https://getontime.no/).
+
+## Architecture
+
+Badger has three primary components: Server, Jobrunner, and Desktop.
+
+Server provides the web interface for setting up shows.
+
+Jobrunner handles media processing, including checking file quality and normalising loudness.
+
+Desktop interfaces with Server to automatically import media into OBS and vMix, and load the running order into Ontime.
+
+Badger also requires a few other services to function:
+
+- A [PostgreSQL](https://www.postgresql.org/) database
+- [Minio](https://min.io/) (or other S3-compatible) file storage
+- [Tusd](https://github.com/tus/tusd) (or other [Tus](https://tus.io)-compatible) file upload server
+
+![Badger architecture diagram](./Badger.png)

handbook/docs/intro.md

@@ -0,0 +1,50 @@
+import composeFile from "!!raw-loader!../../docker-compose-example.yml";
+import CodeBlock from "@theme/CodeBlock";
+
+export const sidebar_position = 2;
+export const sidebar_label = "Installation";
+
+# Requirements
+
+Badger has three primary components: Server, Jobrunner, and Desktop.
+
+Server must be accessible from the internet or your local network. Jobrunner runs as a stand-alone service and does not need to be accessible from the internet.
+
+Server and Jobrunner are distributed as Docker images and must be run in a Docker environment. Desktop is distributed as a Windows installer.
+
+Desktop must be installed on the same computer as OBS/vMix, and currently only officially supports Windows (it can be built for macOS and Linux, but official builds are not provided).
+
+Badger also requires a few other services to function:
+
+- A [PostgreSQL](https://www.postgresql.org/) database
+- [Minio](https://min.io/) (or other S3-compatible) file storage (which could be S3 itself)
+- [Tusd](https://github.com/tus/tusd) (or other [Tus](https://tus.io)-compatible) file upload server
+
+## Docker Installation
+
+Badger Server and Jobrunner are distributed as Docker images. You can run them using Docker Compose. Here is an example `docker-compose.yml` file:
+
+<CodeBlock language="yaml" metastring="docker-compose.yml">
+  {composeFile}
+</CodeBlock>
+
+### Access
+
+Once you have Badger running, you can access the web interface at `http://localhost:3000` (or the IP address of the server if you are running it remotely).
+
+## Desktop
+
+The Badger Desktop app is distributed as a Windows installer. You can download it from the [Badger releases page](https://github.com/ystv/badger/releases).
+
+:::note[What's a YSTV build?]
+
+On the releases page you will see `ystv` in some of the build names.
+These are builds of Badger Desktop that are connected to [YSTV](https://ystv.co.uk)'s Sentry instance.
+We'd suggest you only use these if you are a member of YSTV, otherwise use the non-`ystv` builds.
+
+:::
+
+### Configuration
+
+When running Badger Desktop, you will be asked for a server URL and a password.
+The server URL is the address of your Badger Server, and the password is the value of the `API_SHARED_SECRET` environment variable.

handbook/docs/requirements.mdx

@@ -0,0 +1,114 @@
+import { themes as prismThemes } from "prism-react-renderer";
+import type { Config } from "@docusaurus/types";
+import type * as Preset from "@docusaurus/preset-classic";
+
+const config: Config = {
+  title: "Badger",
+  tagline: "Media management for live broadcast",
+  favicon: "img/favicon.ico",
+
+  // Set the production url of your site here
+  url: "https://ystv.github.io",
+  // Set the /<baseUrl>/ pathname under which your site is served
+  // For GitHub pages deployment, it is often '/<projectName>/'
+  baseUrl: "/badger/",
+
+  // GitHub pages deployment config.
+  // If you aren't using GitHub pages, you don't need these.
+  organizationName: "ystv", // Usually your GitHub org/user name.
+  projectName: "badger", // Usually your repo name.
+
+  onBrokenLinks: "throw",
+  onBrokenMarkdownLinks: "warn",
+
+  // Even if you don't use internationalization, you can use this field to set
+  // useful metadata like html lang. For example, if your site is Chinese, you
+  // may want to replace "en" with "zh-Hans".
+  i18n: {
+    defaultLocale: "en",
+    locales: ["en"],
+  },
+
+  presets: [
+    [
+      "classic",
+      {
+        docs: {
+          sidebarPath: "./sidebars.ts",
+          // Please change this to your repo.
+          // Remove this to remove the "edit this page" links.
+          editUrl: "https://github.com/ystv/badger/tree/main/handbook/",
+        },
+        blog: {
+          showReadingTime: true,
+          // Please change this to your repo.
+          // Remove this to remove the "edit this page" links.
+          editUrl: "https://github.com/ystv/badger/tree/main/handbook/",
+        },
+        theme: {
+          customCss: "./src/css/custom.css",
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  themeConfig: {
+    // Replace with your project's social card
+    image: "img/docusaurus-social-card.jpg",
+    navbar: {
+      title: "Badger",
+      logo: {
+        alt: "Badger Logo",
+        src: "img/logo.svg",
+      },
+      items: [
+        {
+          type: "docSidebar",
+          sidebarId: "docsSidebar",
+          position: "left",
+          label: "Docs",
+        },
+        { to: "/blog", label: "Blog", position: "left" },
+        {
+          href: "https://github.com/ystv/badger",
+          label: "GitHub",
+          position: "right",
+        },
+      ],
+    },
+    footer: {
+      style: "dark",
+      links: [
+        {
+          title: "Docs",
+          items: [
+            {
+              label: "Tutorial",
+              to: "/docs/intro",
+            },
+          ],
+        },
+        {
+          title: "More",
+          items: [
+            {
+              label: "Blog",
+              to: "/blog",
+            },
+            {
+              label: "GitHub",
+              href: "https://github.com/ystv/badger",
+            },
+          ],
+        },
+      ],
+      copyright: `Copyright © ${new Date().getFullYear()} York Student Television. Built with Docusaurus.`,
+    },
+    prism: {
+      theme: prismThemes.github,
+      darkTheme: prismThemes.dracula,
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;