From d27c6e5e8585d00f8838688959e2c6d8544a0b01 Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Wed, 27 May 2020 18:03:45 -0400 Subject: [PATCH] Adding scroll-to-top on index, merging track-types --- docs/_config.yml | 1 + docs/_data/nav.yml | 16 +++++++----- docs/_layouts/default.html | 1 - docs/_layouts/splash.html | 51 ++++++++++++++++++++++++++++++++++++-- docs/dashboard.md | 3 +-- docs/settings.md | 23 +++++++++++------ docs/track-types.md | 44 -------------------------------- docs/troubleshooting.md | 14 ++++++----- 8 files changed, 84 insertions(+), 69 deletions(-) delete mode 100644 docs/track-types.md diff --git a/docs/_config.yml b/docs/_config.yml index 4a9fb05b3..30a8c2de9 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -12,6 +12,7 @@ favicon: favicon.ico headimage: img/header.jpg headtext: Open Source Radio Automation headsubtext: Everything you need to get your terrestrial / on-line radio station up and broadcasting like a pro - without breaking the bank! +# items below - only for first front page link headbuttonurl: index#get-started headbuttontext: Get LibreTime diff --git a/docs/_data/nav.yml b/docs/_data/nav.yml index 1c11b746a..9df314465 100644 --- a/docs/_data/nav.yml +++ b/docs/_data/nav.yml @@ -1,8 +1,12 @@ topnav: +- page: Introduction + url: index - page: Docs - url: quickstart + url: scheduling-shows - page: Contribute url: contribute +- page: Github + url: https://github.com/LibreTime/libretime - page: Sponsor url: https://opencollective.com/libretime @@ -15,9 +19,7 @@ docsnav: url: host-configuration - page: 3. Setting the Server Time url: setting-the-server-time - - page: 4. Configuring Track Types - url: track-types - - page: 5. Setting up SSL + - page: 4. Setting up SSL url: ssl-config - page: - section: Using LibreTime @@ -26,8 +28,6 @@ docsnav: url: live-broadcast - page: Dashboard and Calendar url: dashboard - - page: Help! - url: troubleshooting - page: Listen To Your Stream url: listen - page: Managing Users @@ -54,6 +54,10 @@ docsnav: url: interface-customization - page: Upgrading LibreTime url: upgrading +- section: Troubleshooting + contents: + - page: Basic Troubleshooting + url: troubleshooting - section: Radio Broadcasting 101 contents: - page: UNESCO Public Radio Guide diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 5f2faff57..049dd2cbf 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -49,7 +49,6 @@ - diff --git a/docs/_layouts/splash.html b/docs/_layouts/splash.html index 8857ff153..df4e69652 100644 --- a/docs/_layouts/splash.html +++ b/docs/_layouts/splash.html @@ -55,6 +55,14 @@ + + + + + + + Back to top +
@@ -71,6 +79,7 @@ {{ site.headsubtext}}

{{ site.headbuttontext }} + Read the Docs @@ -141,6 +150,7 @@ +
@@ -169,7 +179,7 @@
- +
@@ -205,7 +215,7 @@
- +
@@ -282,5 +292,42 @@ + + diff --git a/docs/dashboard.md b/docs/dashboard.md index 08f6e5597..c8803b39f 100644 --- a/docs/dashboard.md +++ b/docs/dashboard.md @@ -10,8 +10,7 @@ title: Dashboard and Calendar # Dashboard {#dashboard} The Dashboard is divided into two sections a Library section divided between -[Tracks](../tracks), [Playlists](../playlists), [Smart Blocks](../smartblocks), -[Webstreams](../webstreams), and [Podcasts](../podcasts), with the **Scheduled +Tracks, Playlists, Smart Blocks, Webstreams, and Podcasts, with the **Scheduled Shows** dialog on the right. This page provides an overview of the right-hand interface. Check the links to see information about the other sections which provide the content that can be scheduled. diff --git a/docs/settings.md b/docs/settings.md index d2cc85eb6..aacb7e1bb 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -5,6 +5,7 @@ title: Settings > Quick Links: - [General Settings](#general) +- [Track Types](#types) - [Stream Settings](#stream) - [LibreTime Status](#status) @@ -93,10 +94,20 @@ their username on the right side of the menu bar. ---- -> Quick Links: -- [General Settings](#general) -- [Stream Settings](#stream) -- [LibreTime Status](#status) +# Track Types {#types} + +## Create track types + +1. Click **Settings** +1. Click **Track Types** +1. Click **New Track Type** +1. On the "Code" field, type a unique code that can be easily identifiable. Example, for Music use "MUS" or for Sound Effects use something like "FX". +1. On the "Type Name" field, type a the name of the type of tracks. Example, "Station IDs". +1. On the "Description" field, enter the description of the type given. +1. On the "Visibility" drop down menu, choose to enable or disable the track type. By default, it is enabled. If disabled, it won't be shown across Libretime or in the API for developers. +1. Click **Save**. + +---- # Stream Settings {#stream} @@ -181,10 +192,6 @@ Any connection problems between Liquidsoap and Icecast or SHOUTcast are shown on ------ -> Quick Links: -- [General Settings](#general) -- [Stream Settings](#stream) -- [LibreTime Status](#status) # The Status page {#status} diff --git a/docs/track-types.md b/docs/track-types.md deleted file mode 100644 index 921ec19b5..000000000 --- a/docs/track-types.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: docs -title: Working with Track Types ---- - - -## Using track types when uploading tracks - -1. Click **Upload** -1. The default track type is 'Music' -1. Click the drop down menu to select another type - -Now when uploading tracks, you have the option to set a track type. This helps better identify and organize track files. If you have a group of files for commercials that needs to be uploaded, you can "Commercial" in the drop down menu and then upload the files. Commercial is included by default with LT, but you can create your own type in settings. - -## Create track types - -1. Click **Settings** -1. Click **Track Types** -1. Click **New Track Type** -1. On the "Code" field, type a unique code that can be easily identifiable. Example, for Music use "MUS" or for Sound Effects use something like "FX". -1. On the "Type Name" field, type a the name of the type of tracks. Example, "Station IDs". -1. On the "Description" field, enter the description of the type given. -1. On the "Visibility" drop down menu, choose to enable or disable the track type. By default, it is enabled. If disabled, it won't be shown across Libretime or in the API for developers. -1. Click **Save**. - -## Using track types with the uploaded tracks - -1. Click **Tracks**. -1. Select a track and click **Edit** -1. On "Track Type" drop down menu, select the type you would like use. Only the enabled track types that were added in Settings > Track Types will be shown here. -1. Click **Save**. - -## Using track types with advanced search - -1. Click **Tracks**. -1. Click on the down caret **▼** that is to the right inside search box -1. On **Type** select the type of track you're searching for. - -## Using track types in Smart Blocks - -1. Click **Smart Blocks**. -1. On "Select criteria" drop down menu, select "Track Type" -1. On "Select modifier" drop down menu, select "is" or "is not" -1. On "Select Track Type" drop down menu, select the track type. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 9eb390dee..a1b8c7dd3 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -76,9 +76,11 @@ where the hostname is *airtime.example.com*. If the hostname has changed, it may 3. Enter the following commands to set up authentication and grant permissions. The *rabbitmqctl add\_user* command requires the RabbitMQ password from the /etc/airtime/airtime.conf file as an argument. The *rabbitmqctl set\_permissions* command should be entered on one line, with the list of Airtime services repeated three times: - rabbitmqctl add_vhost /airtime - rabbitmqctl add_user airtime XXXXXXXXXXXXXXXXXXXX - rabbitmqctl set_permissions -p /airtime airtime - "airtime-pypo|pypo-fetch|airtime-analyzer|media-monitor" -   "airtime-pypo|pypo-fetch|airtime-analyzer|media-monitor" -  "airtime-pypo|pypo-fetch|airtime-analyzer|media-monitor" +``` +rabbitmqctl add_vhost /airtime +rabbitmqctl add_user airtime XXXXXXXXXXXXXXXXXXXX +rabbitmqctl set_permissions -p /airtime airtime + "airtime-pypo|pypo-fetch|airtime-analyzer|media-monitor" +  "airtime-pypo|pypo-fetch|airtime-analyzer|media-monitor" +  "airtime-pypo|pypo-fetch|airtime-analyzer|media-monitor" +``` \ No newline at end of file