Update self-streaming guide and README

docs_v2/README.md

@@ -1,48 +1,90 @@
-# GoCast docs
+# GoCast Docs
 
-Source code for GoCast's docs and changelogs from [docs.tum.live](https://docs.tum.live).
+Contains the new docs for GoCast.
+
+A prototype can be found [here](https://tumlive-docs.pages.dev/).
 
 ## Getting started
 
-First, install the necessary dependencies:
+To start the development server, run:
 
 ```bash
-npm i
+npm run dev
 ```
-Then, start the server:
+
+To build the project site **for production**, run:
+
 ```bash
-npm run start
+npm run build
 ```
 
-Then, start the server:
+> The static files are generated in the `build` folder.
+
+To start the production server, run:
+
 ```bash
 npm run start
 ```
 
-Then, start the server:
-```bash
-npm run start
+## How to add a new page
+
+To add a new page, create a new markdown file in the `docs` directory. The file should have the following structure:
+
+```markdown
+---
+title: Page Title
+---
+
+# Page Title
+
+Page content goes here.
 ```
 
-## Build site
+The `title` field in the front matter is used to generate the page title in the sidebar.
 
-Build site **for production**:
+## How to add a new section
 
-```bash
-npm run build
+To add a new section, create a new directory in the `docs` directory. Inside the directory, create a markdown file for each page in the section. The directory should have an `index.md` file with the following structure:
+
+```markdown
+---
+title: Section Title
+---
+
+# Section Title
+
+Section description goes here.
 ```
 
-The static files are generated in the `build` folder.
+The `title` field in the front matter is used to generate the section title in the sidebar.
 
-## Deploy site
+## How to add a new sidebar item
 
-Test production build locally:
+To add a new sidebar item, edit the `sidebar.json` file in the `data` directory. The file should have the following structure:
 
-```bash
-npm run serve
+```json
+[
+  {
+    "title": "Section Title",
+    "children": [
+      {
+        "title": "Page Title",
+        "slug": "page-slug"
+      }
+    ]
+  }
+]
 ```
 
+The `title` field is used to generate the section title in the sidebar. The `children` field is an array of sidebar items. Each sidebar item should have a `title` field and a `slug` field. The `title` field is used to generate the page title in the sidebar. The `slug` field is used to generate the page URL.
+
+## More information
+
+For more information, see the official Docusaurus docs [here](https://docusaurus.io/docs).
+
+
+
 ## Credit
 
-https://docusaurus.io/
+https://docusaurus.io \
 https://github.com/facebook/docusaurus

docs_v2/docs/selfhosting/prerequisites.md

@@ -3,7 +3,7 @@ title: "Prerequisites"
 sidebar_position: 1
 ---
 
-## Prerequisites
+## Hardware
 
 We deploy GoCast on our own hardware in VMs. Any cloud hosting provider works just as well.
 You will need the following hardware configuration:

docs_v2/docs/usage/self-streaming.md

@@ -4,23 +4,19 @@ sidebar_position: 4
 description: "Information on how to stream from your own computer."
 ---
 
-## Self Streaming
-
 This guide contains information on how to stream from your own computer.
 
-### Gather streaming key.
+## Gather streaming key.
 
 - Open the course's admin page
 - Create a stream with the location "self stream" if it doesn't exist already.
 - Navigate to the stream and click `show keys`.
 
-### 1. Create a personal token
-
-- Go to your [token settings](https://live.rbg.tum.de/admin/tokens)
-
-- Create a new token of type `lecturer` and store it securely
+## OBS
 
-### OBS
+:::warning
+Self streaming can be unreliable and we cannot guarantee proper recording of your lecture just yet. In some cases, recordings might be corrupted. **Please save a local copy just in case using the streaming software of your choice.**
+:::
 
 - Download and install OBS from [here](https://obsproject.com/).
 - Open OBS and click on `Settings` in the bottom right corner.

docs_v2/docusaurus.config.js

@@ -202,13 +202,14 @@ const config = {
         disableSwitch: false,
         respectPrefersColorScheme: false,
       },
-      algolia: {
+      /* Enable once the new docs are accepted and soon to be deployed in production
+        algolia: {
         // The application ID provided by Algolia
         appId: "3YMWAWWJ0X",
         // Public API key: it is safe to commit it
         apiKey: "264acc28faec8429deaf4b14772332cc",
         indexName: "gocast-docs",
-      },
+      },*/
     }),
   scripts: [
     {

docs_v2/versioned_docs/version-beta/deployment/prerequisites.md

@@ -4,7 +4,7 @@ sidebar_position: 2
 description: "What you need before you can start deploying GoCast."
 ---
 
-# Prerequisites
+## Hardware
 
 Make sure to check the following system requirements before deploying GoCast:
 

docs_v2/versioned_docs/version-beta/selfhosting/prerequisites.md

@@ -3,7 +3,7 @@ title: "Prerequisites"
 sidebar_position: 1
 ---
 
-## Prerequisites
+## Hardware
 
 We deploy GoCast on our own hardware in VMs. Any cloud hosting provider works just as well.
 You will need the following hardware configuration:

docs_v2/versioned_docs/version-beta/usage/self-streaming.mdx

@@ -0,0 +1,78 @@
+---
+title: "Self Streaming 🆕"
+sidebar_position: 4
+description: "Information on how to stream from your own computer."
+---
+
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+
+This guide contains information on how to stream from your own computer.
+
+## Gather streaming key.
+
+### Method 1: Using lecturer token (recommended)
+
+- Open the token panel of the admin page ([here](https://live.rbg.tum.de/admin/token)).
+
+- Create a new token by clicking on the `+` button.
+
+- Copy the token and paste it into the streaming software of your choice.
+
+:::danger
+Do not share your token with anyone. It is unique to you and allows access to your streams. If you suspect that your token has been compromised, please delete it and create a new one.
+:::
+
+### Method 2: Using course admin page
+
+- Open the course's admin page
+- Create a stream with the location "self stream" if it doesn't exist already.
+- Navigate to the stream and click `show keys`.
+
+## OBS
+
+:::warning
+Self streaming can be unreliable and we cannot guarantee proper recording of your lecture just yet. In some cases, recordings might be corrupted. **Please save a local copy just in case using the streaming software of your choice.**
+:::
+
+<Tabs>
+<TabItem value="obs" label="OBS">
+
+- Download and install OBS from [here](https://obsproject.com/).
+- Open OBS and click on `Settings` in the bottom right corner.
+- Click on `Stream` in the left sidebar.
+- Select `Custom` from the dropdown menu.
+- Paste the stream key and the stream server from the course's admin page into the `Stream key` and `Stream server` field.
+- Click on `Output` in the left sidebar.
+- Click on `Streaming` in the top menu.
+- Select `Simple` from the `Output Mode` dropdown menu.
+- Insert the following settings:
+- Video Bitrate: 2500 – 4000
+- Audio Bitrate: 192 kbp/s (or 128kbp/s)
+- Video Encoder: x264
+- Please ensure that your output is scaled to 1920x1080.
+
+</TabItem>
+<TabItem value="zoom" label="Zoom">
+
+- Sign in to the Zoom web portal.
+- Click `Meetings`.
+- Click `Schedule a Meeting` and enter the required information to schedule a meeting.
+- Click `Save` to display a set of tabs with advanced options.
+- Click the `Live Streaming` tab, then click `Configure Custom Streaming Service`.
+- Follow the instructions located in the green box, which were provided by your administrator. Contact your administrator if the instructions do not include sufficient information, or enable `Configure live stream during the meeting` to enter the details live.
+- Click `Save` to save your livestreaming settings. The host will be able to livestream this meeting without needing to add these settings after the meeting begins.
+
+</TabItem>
+<TabItem value="teams" label="Teams">
+
+- Open Microsoft Teams and join the meeting or webinar you wish to live stream.
+- Add the `Custom Streaming` app to the meeting.
+- Click `Add` and `Save`.
+- In the right-hand panel that opens, paste the `Stream URL` and `Stream Key`.
+- Click `Start streaming` in the lower right, then select `Allow` in the dialog box when it appears.
+- You’re now live streaming! Share your screen and/or use your cameras and microphones to run your event as you would any normal Microsoft Teams meeting.
+- When you’re finished with the event, you can stop streaming via Teams and YouTube.
+
+</TabItem>
+</Tabs>