fix broken links in docs

roflcoopter · Dec 9, 2024 · 01143a9 · 01143a9
1 parent 7902f0e
commit 01143a9
Show file tree

Hide file tree

Showing 21 changed files with 52 additions and 53 deletions.
diff --git a/docs/src/pages/components-explorer/_components/ComponentCard/index.tsx b/docs/src/pages/components-explorer/_components/ComponentCard/index.tsx
@@ -45,7 +45,7 @@ function ComponentCardTag({ tags }: { tags: DomainType[] }) {
 }
 
 function ComponentCard({ component }: { component: Component }) {
-  const componentLink = `components-explorer/components/${component.name}`;
+  const componentLink = `/components-explorer/components/${component.name}`;
   return (
     <li key={component.title} className="card shadow--md outline">
       <Link href={componentLink}>

diff --git a/...s-explorer/components/troubleshooting.mdx → ...onents/ComponentTroubleshooting/index.mdx b/...s-explorer/components/troubleshooting.mdx → ...onents/ComponentTroubleshooting/index.mdx
@@ -2,4 +2,4 @@ import ComponentTroubleshooting from "@site/src/pages/components-explorer/_compo
 
 ## Troubleshooting
 
-<ComponentTroubleshooting meta={props.meta} />
+<ComponentTroubleshooting meta={props.meta} logs={props.logs} />
diff --git a/docs/src/pages/components-explorer/_domains/face_recognition/index.mdx b/docs/src/pages/components-explorer/_domains/face_recognition/index.mdx
@@ -5,7 +5,7 @@ import PostProcessorLabels from "@site/src/pages/components-explorer/_domains/po
 
 ## Face recognition
 
-Face recognition runs as a <Link href="/docs/documentation/configuration#post-processors">post processor</Link> when a specific object is detected.
+Face recognition runs as a <Link href="/docs/documentation/configuration/domains/#post-processors">post processor</Link> when a specific object is detected.
 
 ### Labels \{#face-recognition-labels}
 

diff --git a/docs/src/pages/components-explorer/_domains/image_classification/index.mdx b/docs/src/pages/components-explorer/_domains/image_classification/index.mdx
@@ -4,7 +4,7 @@ import PostProcessorLabels from "@site/src/pages/components-explorer/_domains/po
 
 ## Image classification
 
-Image classification runs as a <Link href="/docs/documentation/configuration#post-processors">post processor</Link> when a specific object is detected.
+Image classification runs as a <Link href="/docs/documentation/configuration/domains/#post-processors">post processor</Link> when a specific object is detected.
 
 Image classification works by labeling and image with known objects and provide a score.
 Classifiers have more fine tuned models than object detectors typically have, which allows them to have more detailed detections.

diff --git a/docs/src/pages/components-explorer/_domains/license_plate_recognition/index.mdx b/docs/src/pages/components-explorer/_domains/license_plate_recognition/index.mdx
@@ -2,7 +2,7 @@ import Link from "@docusaurus/Link";
 
 ## License plate recognition
 
-License plate recognition runs as a <Link href="/docs/documentation/configuration#post-processors">post processor</Link> when a specific object is detected.
+License plate recognition runs as a <Link href="/docs/documentation/configuration/domains/#post-processors">post processor</Link> when a specific object is detected.
 
 You can track known license plates by adding them to the `known_plates` list in the configuration.
 Known plates will be reported as binary sensors.

diff --git a/docs/src/pages/components-explorer/_domains/object_detector/index.mdx b/docs/src/pages/components-explorer/_domains/object_detector/index.mdx
@@ -8,7 +8,7 @@ An object detector scans an image to identify multiple objects and their positio
 
 :::tip
 
-Object detectors can be taxing on the system, so it is wise to combine it with a [motion detector](/docs/documentation/configuration#motion-detector-domain)
+Object detectors can be taxing on the system, so it is wise to combine it with a [motion detector](/docs/documentation/configuration/domains/#motion-detector-domain)
 
 :::
 

diff --git a/docs/src/pages/components-explorer/components/background_subtractor/index.mdx b/docs/src/pages/components-explorer/components/background_subtractor/index.mdx
@@ -1,7 +1,7 @@
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 import MotionDetector from "@site/src/pages/components-explorer/_domains/motion_detector/index.mdx";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -43,7 +43,7 @@ background_subtractor:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 <MotionDetector meta={ComponentMetadata} />
 

diff --git a/docs/src/pages/components-explorer/components/codeprojectai/index.mdx b/docs/src/pages/components-explorer/components/codeprojectai/index.mdx
@@ -3,10 +3,10 @@ import CodeBlock from "@theme/CodeBlock";
 
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 import FaceRecognition from "@site/src/pages/components-explorer/_domains/face_recognition/index.mdx";
 import LicensePlateRecognition from "@site/src/pages/components-explorer/_domains/license_plate_recognition/index.mdx";
 import ObjectDetector from "@site/src/pages/components-explorer/_domains/object_detector/index.mdx";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -92,7 +92,7 @@ codeprojectai:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 <FaceRecognition />
 

diff --git a/docs/src/pages/components-explorer/components/compreface/index.mdx b/docs/src/pages/components-explorer/components/compreface/index.mdx
@@ -1,7 +1,7 @@
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 import FaceRecognition from "@site/src/pages/components-explorer/_domains/face_recognition/index.mdx";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -44,7 +44,7 @@ compreface:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 <FaceRecognition />
 

diff --git a/docs/src/pages/components-explorer/components/darknet/index.mdx b/docs/src/pages/components-explorer/components/darknet/index.mdx
@@ -4,8 +4,8 @@ import Tabs from "@theme/Tabs";
 
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 import ObjectDetector from "@site/src/pages/components-explorer/_domains/object_detector/index.mdx";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -80,7 +80,7 @@ darknet:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 <ObjectDetector
   meta={ComponentMetadata}

diff --git a/docs/src/pages/components-explorer/components/deepstack/index.mdx b/docs/src/pages/components-explorer/components/deepstack/index.mdx
@@ -3,9 +3,9 @@ import CodeBlock from "@theme/CodeBlock";
 
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 import FaceRecognition from "@site/src/pages/components-explorer/_domains/face_recognition/index.mdx";
 import ObjectDetector from "@site/src/pages/components-explorer/_domains/object_detector/index.mdx";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -49,7 +49,7 @@ deepstack:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 <ObjectDetector
   meta={ComponentMetadata}

diff --git a/docs/src/pages/components-explorer/components/dlib/index.mdx b/docs/src/pages/components-explorer/components/dlib/index.mdx
@@ -2,8 +2,8 @@ import Link from "@docusaurus/Link";
 
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 import FaceRecognition from "@site/src/pages/components-explorer/_domains/face_recognition/index.mdx";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -33,7 +33,7 @@ dlib:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 <FaceRecognition />
 

diff --git a/docs/src/pages/components-explorer/components/edgetpu/index.mdx b/docs/src/pages/components-explorer/components/edgetpu/index.mdx
@@ -1,8 +1,8 @@
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 import ImageClassification from "@site/src/pages/components-explorer/_domains/image_classification/index.mdx";
 import ObjectDetector from "@site/src/pages/components-explorer/_domains/object_detector/index.mdx";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -50,7 +50,7 @@ edgetpu:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 <ObjectDetector
   meta={ComponentMetadata}

diff --git a/docs/src/pages/components-explorer/components/ffmpeg/index.mdx b/docs/src/pages/components-explorer/components/ffmpeg/index.mdx
@@ -3,8 +3,8 @@ import Tabs from "@theme/Tabs";
 
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 import Camera from "@site/src/pages/components-explorer/_domains/camera/index.mdx";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -56,7 +56,7 @@ ffmpeg:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 <Camera />
 
@@ -190,19 +190,10 @@ ffmpeg_recoverable_errors:
 ### Recorder
 
 [FFmpeg segments](https://www.ffmpeg.org/ffmpeg-formats.html#segment_002c-stream_005fsegment_002c-ssegment) are used to handle recordings.<br />
-FFmpeg will write small 5 second segments of the stream to disk, and in case of any recording starting, Viseron will find the appropriate segments and concatenate them together.<br />
-The reason for using segments instead of just starting the recorder on an event, is to support the `lookback` feature which makes it possible to record _before_ an event actually happened.
-
-<details>
-  <summary>The default concatenation command</summary>
+FFmpeg will write small 5 second segments of the stream to disk.<br />
 
-```
-ffmpeg -hide_banner -loglevel error -y -protocol_whitelist file,pipe -f concat -safe 0 -i - -c:v copy {outfile.mp4}
-```
-
-</details>
-
-If you want to re-encode the video you can choose `codec`, `video_filters` and optionally `hwaccel_args`.
+The reason for using segments instead of just starting the recorder on an event, is to support the `lookback` feature which makes it possible to record _before_ an event actually happened.
+It also makes it possible to have continuous recordings.
 
 ### Store segments in memory
 

diff --git a/docs/src/pages/components-explorer/components/gstreamer/index.mdx b/docs/src/pages/components-explorer/components/gstreamer/index.mdx
@@ -1,7 +1,7 @@
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 import Camera from "@site/src/pages/components-explorer/_domains/camera/index.mdx";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -56,7 +56,7 @@ gstreamer:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 <Camera />
 

diff --git a/docs/src/pages/components-explorer/components/logger/index.mdx b/docs/src/pages/components-explorer/components/logger/index.mdx
@@ -1,7 +1,9 @@
-import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
-import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
 import TabItem from "@theme/TabItem";
 import Tabs from "@theme/Tabs";
+
+import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
+import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
+
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
 
@@ -28,7 +30,7 @@ logger:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 ## Available levels
 

diff --git a/docs/src/pages/components-explorer/components/mog2/index.mdx b/docs/src/pages/components-explorer/components/mog2/index.mdx
@@ -1,7 +1,7 @@
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 import MotionDetector from "@site/src/pages/components-explorer/_domains/motion_detector/index.mdx";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -43,7 +43,7 @@ mog2:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 <MotionDetector meta={ComponentMetadata} />
 

diff --git a/docs/src/pages/components-explorer/components/mqtt/index.mdx b/docs/src/pages/components-explorer/components/mqtt/index.mdx
@@ -3,7 +3,7 @@ import Tabs from "@theme/Tabs";
 
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -29,7 +29,7 @@ mqtt:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 ## Topics
 

diff --git a/docs/src/pages/components-explorer/components/nvr/index.mdx b/docs/src/pages/components-explorer/components/nvr/index.mdx
@@ -1,6 +1,6 @@
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -30,6 +30,6 @@ nvr:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 <ComponentTroubleshooting meta={ComponentMetadata} />
diff --git a/docs/src/pages/components-explorer/components/storage/index.mdx b/docs/src/pages/components-explorer/components/storage/index.mdx
@@ -1,6 +1,6 @@
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -49,7 +49,7 @@ It will also store continuous recordings on `/ssd/tier1` for 1 day, after which
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 :::caution
 
@@ -92,8 +92,8 @@ For technical reasons it is very likely that there will be a few extra megabytes
 
 ### Continuous (24/7) recordings
 
-To enable continuous recordings for **all** cameras you use the `continuous` configuration option for a tier.
-The below example will store 10gb of continuous recordings in the default location `/segments`.
+To allocate space for continuous recordings for **all** cameras you use the `continuous` configuration option for a tier.
+The below example will store 10gb of continuous recordings **per camera** in the default location `/segments`.
 No events will be stored.
 
 <details>
@@ -111,13 +111,19 @@ storage:
 
 </details>
 
+:::info
+
+For each camera that you want to store continuous recordings for, you need to set `continuous_recording: true` under `recorder` in the camera configuration.
+
+:::
+
 :::tip
 
 To set camera specific options, you can use `continuous` or override the entire `storage` configuration under your camera configuration.
 See the `recorder` documentation for the component that provides your cameras.
 
-[FFmpeg](/components-explorer/components/FFmpeg)<br></br>
-[GStreamer](/components-explorer/components/GStreamer)
+[FFmpeg](/components-explorer/components/ffmpeg)<br></br>
+[GStreamer](/components-explorer/components/gstreamer)
 
 :::
 

diff --git a/docs/src/pages/components-explorer/components/webserver/index.mdx b/docs/src/pages/components-explorer/components/webserver/index.mdx
@@ -1,6 +1,6 @@
 import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration";
 import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader";
-import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx";
+import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx";
 
 import ComponentMetadata from "./_meta";
 import config from "./config.json";
@@ -31,6 +31,6 @@ webserver:
 
 </details>
 
-<ComponentConfiguration meta={ComponentMetadata} config={config} />
+<ComponentConfiguration config={config} />
 
 <ComponentTroubleshooting meta={ComponentMetadata} />
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@ import ComponentTroubleshooting from "@site/src/pages/components-explorer/_compo

		## Troubleshooting

		<ComponentTroubleshooting meta={props.meta} />
		<ComponentTroubleshooting meta={props.meta} logs={props.logs} />
-Original file line number
+Diff line change
@@ Expand Up @@
     :::tip
-    Object detectors can be taxing on the system, so it is wise to combine it with a [motion detector](/docs/documentation/configuration#motion-detector-domain)
+    Object detectors can be taxing on the system, so it is wise to combine it with a [motion detector](/docs/documentation/configuration/domains/#motion-detector-domain)
     :::
@@ Expand Down @@