From c75ff220cb02d46d963fca570eb6d26c9c89fdd5 Mon Sep 17 00:00:00 2001
From: David Trattnig <david.trattnig@o94.at>
Date: Mon, 4 May 2020 20:46:08 +0200
Subject: [PATCH] Added FAQ section.
---
README.md | 1 +
docs/configuration-guide.md | 16 +---------------
docs/developer-guide.md | 1 +
docs/engine-features.md | 7 +------
docs/frequently-asked-questions.md | 28 ++++++++++++++++++++++++++++
docs/installation-development.md | 1 +
docs/installation-production.md | 1 +
docs/running-docker.md | 1 +
docs/setup-audio-store.md | 1 +
9 files changed, 36 insertions(+), 21 deletions(-)
create mode 100644 docs/frequently-asked-questions.md
diff --git a/README.md b/README.md
index 3fd3472b..3f0f49ae 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,7 @@ To learn more, checkout the [Engine Developer Guide](docs/developer-guide.md) or
- [Developer Guide](docs/developer-guide.md)
- [Engine Features](docs/engine-features.md)
+- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
## About
diff --git a/docs/configuration-guide.md b/docs/configuration-guide.md
index 9deb1ba6..13eb3c86 100644
--- a/docs/configuration-guide.md
+++ b/docs/configuration-guide.md
@@ -24,7 +24,6 @@ This page goes into detail on what is possible to configure within the engine.
- [Frequently Asked Questions](#frequently-asked-questions)
- [Which Audio Interface / Soundcard is compatible with Aura?](#which-audio-interface--soundcard-is-compatible-with-aura)
- [ALSA Settings](#alsa-settings)
- - [Install: I don't want to install all Liquidsoap Audio plugins. How?](#install-i-dont-want-to-install-all-liquidsoap-audio-plugins-how)
- [In the Liquidsoap Logs I get 'Error when starting output output_lineout_0: Failure("Error while setting open_pcm: Device or resource busy")!'. What does it mean?](#in-the-liquidsoap-logs-i-get-error-when-starting-output-output_lineout_0-failureerror-while-setting-open_pcm-device-or-resource-busy-what-does-it-mean)
- [How can I find the audio device IDs, required for settings in engine.ini?](#how-can-i-find-the-audio-device-ids-required-for-settings-in-engineini)
- [Read more](#read-more)
@@ -168,20 +167,6 @@ Engine has been tested with following audio interfaces:
### ALSA Settings
-#### Install: I don't want to install all Liquidsoap Audio plugins. How?
-
-Depending on what stream you are going to send, and what recordings you are going to use,
-install one or some of the following:
-
-```bash
-sudo apt install \
- liquidsoap-plugin-aac # for aac support
- liquidsoap-plugin-flac # for flac support
- liquidsoap-plugin-lame liquidsoap-plugin-mad # for mp3 support
- liquidsoap-plugin-opus # for opus support
- liquidsoap-plugin-vorbis # for ogg support
-```
-
#### In the Liquidsoap Logs I get 'Error when starting output output_lineout_0: Failure("Error while setting open_pcm: Device or resource busy")!'. What does it mean?
You probably have set a wrong or occupied device ID.
@@ -225,3 +210,4 @@ Well, this is - at least for me - a hard one. I could not manage to find correct
- [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md)
+- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
diff --git a/docs/developer-guide.md b/docs/developer-guide.md
index f02e52cb..9c656672 100644
--- a/docs/developer-guide.md
+++ b/docs/developer-guide.md
@@ -137,3 +137,4 @@ Push some audio file to the filesystem `queue 0`
- [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md)
+- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
diff --git a/docs/engine-features.md b/docs/engine-features.md
index f02e9bdc..f686eab1 100644
--- a/docs/engine-features.md
+++ b/docs/engine-features.md
@@ -123,7 +123,6 @@ schemas:
* `/api/v1/schedule/upcoming` .. Returns the next three schedules, after the one currently playing.
-
```yaml
schemas:
Schedule:
@@ -143,12 +142,10 @@ schemas:
openapi: 3.0.2
```
-
**Clock API**: Retrieve all data relevant for a studio clock.
* `/api/v1/clock` .............. Returns the current show, next show, playlist and time left until the next show.
-
```yaml
schemas:
Clock:
@@ -165,13 +162,11 @@ schemas:
openapi: 3.0.2
```
-
## Web Applications
* `/app/trackservice` ................. Web Application for displaying the Track-Service
* `/app/clock` ........................ Web Application for displaying the studio clock
-
## Read more
- [Overview](/README.md)
@@ -182,4 +177,4 @@ schemas:
- [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md)
-
+- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
diff --git a/docs/frequently-asked-questions.md b/docs/frequently-asked-questions.md
new file mode 100644
index 00000000..7c4160f7
--- /dev/null
+++ b/docs/frequently-asked-questions.md
@@ -0,0 +1,28 @@
+
+# Frequently Asked Questions
+
+<!-- TOC -->
+
+- [Frequently Asked Questions](#frequently-asked-questions)
+ - [Starting Engine](#starting-engine)
+ - [Read More](#read-more)
+
+<!-- /TOC -->
+
+## Starting Engine
+
+**Error when starting output lineout: Failure("Error while setting open_pcm: No such file or directory**
+
+This might indicate some issue with your ALSA device. Check if `aplay -l` and `aplay -L` returns some valid device(s).
+
+## Read More
+
+- [Overview](/README.md)
+- [Installation for Development](installation-development.md)
+- [Installation for Production](installation-production.md)
+- [Running with Docker](running-docker.md)
+- [Setup the Audio Store](docs/setup-audio-store.md)
+- [Configuration Guide](configuration-guide.md)
+- [Developer Guide](developer-guide.md)
+- [Engine Features](engine-features.md)
+- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
diff --git a/docs/installation-development.md b/docs/installation-development.md
index 8dc2d174..a9fb3204 100644
--- a/docs/installation-development.md
+++ b/docs/installation-development.md
@@ -208,3 +208,4 @@ All Engine logs for development can be found under `./logs`.
- [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md)
+- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
diff --git a/docs/installation-production.md b/docs/installation-production.md
index f4538b73..eb288609 100644
--- a/docs/installation-production.md
+++ b/docs/installation-production.md
@@ -323,3 +323,4 @@ Additionally you'll finde Supervisor specific logs under:
- [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md)
+- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
diff --git a/docs/running-docker.md b/docs/running-docker.md
index ae66c31c..624ed453 100644
--- a/docs/running-docker.md
+++ b/docs/running-docker.md
@@ -57,3 +57,4 @@ This section is only relevant if you are an Engine Developer.
- [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md)
+- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
diff --git a/docs/setup-audio-store.md b/docs/setup-audio-store.md
index 0b49d76b..3e551e51 100644
--- a/docs/setup-audio-store.md
+++ b/docs/setup-audio-store.md
@@ -145,3 +145,4 @@ this file. Then restart your Tank Docker container and you should be good to go.
- [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md)
+- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
--
GitLab