From 620e0b521cda66205bfd88ee126b61731e9c0627 Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Sat, 23 May 2020 16:48:49 -0400 Subject: [PATCH] Updating docs --- docs/_data/nav.yml | 4 +++- docs/_layouts/docs.html | 17 +++++++++++++++++ docs/css/creative.min.css | 2 +- docs/features.md | 6 ++---- docs/quickstart.md | 2 +- docs/ssl-config.md | 2 -- docs/upgrading.md | 5 ++++- docs/users.md | 6 +++--- 8 files changed, 31 insertions(+), 13 deletions(-) diff --git a/docs/_data/nav.yml b/docs/_data/nav.yml index f3ec791af..2c9eb8227 100644 --- a/docs/_data/nav.yml +++ b/docs/_data/nav.yml @@ -7,6 +7,8 @@ topnav: url: advanced-configuration - page: Contribute url: contribute +- page: Sponsor + url: https://opencollective.com/libretime docsnav: - section: Install @@ -32,7 +34,7 @@ docsnav: url: scheduling-shows - page: Broadcasting Live url: live-broadcast - - page: Adding Users + - page: Managing Users url: users - page: Listen To Your Stream url: listen diff --git a/docs/_layouts/docs.html b/docs/_layouts/docs.html index e3d8291a9..216112162 100644 --- a/docs/_layouts/docs.html +++ b/docs/_layouts/docs.html @@ -30,6 +30,9 @@ layout: default /* Estimated height of largest sidebar in case of short content */ min-height: 800px; } + section{ + padding:1rem 0 + } {{ site.title }} - {{ page.title }} @@ -74,7 +77,21 @@ layout: default {% endfor %} +
+
+
+
+
+

{{ page.title }}

+
+

+ {{ page.blurb }} +

+
+
+
+
{{ content }} diff --git a/docs/css/creative.min.css b/docs/css/creative.min.css index 7b4c35685..4d6bdea03 100755 --- a/docs/css/creative.min.css +++ b/docs/css/creative.min.css @@ -221,7 +221,7 @@ text-align: right; /* Code Blocks */ code { -color: gray; +color: #f05f40; font-size: .9rem; } diff --git a/docs/features.md b/docs/features.md index 3f41b0544..16005d0e3 100644 --- a/docs/features.md +++ b/docs/features.md @@ -1,11 +1,9 @@ --- layout: page title: Features -blurb: +blurb: Just some of LibreTime's greatest hits --- -Some of LibreTime's greatest hits: - * *Web-based remote station management* - authorized personnel can add programme material, create playlists or smart blocks, and stream in live, all via a web interface. @@ -109,7 +107,7 @@ Optionally, the outgoing Icecast stream can be relayed to a transmitter.

"Can I upgrade to LibreTime?"

-

In theory you can update any pre 3.0 version of AirTime to LibreTime 3.0.0 and above. More information is here.

+

In theory you can update any pre 3.0 version of AirTime to LibreTime 3.0.0 and above. More information is here.

diff --git a/docs/quickstart.md b/docs/quickstart.md index 98e70d73f..ec508b864 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -1,6 +1,6 @@ --- title: Quick Install -layout: page +layout: docs blurb: LibreTime is quick and easy to install and get running. Follow this guide to go from zero to full internet radio station in 10 minutes! --- diff --git a/docs/ssl-config.md b/docs/ssl-config.md index db257e901..b2fd2dff8 100644 --- a/docs/ssl-config.md +++ b/docs/ssl-config.md @@ -3,8 +3,6 @@ layout: docs title: Setting up SSL --- -# Setting up SSL - To increase the security of your server, you can enable encrypted access to the LibreTime administration interface, and direct your users towards this more secure login page. The main advantage of using this encryption is that your remote users' login names and passwords are not sent in plain text across the public Internet or untrusted local networks, such as shared Wi-Fi access points. ## Deploying a certificate with Certbot diff --git a/docs/upgrading.md b/docs/upgrading.md index 5d009c8bd..9b7b1d95a 100644 --- a/docs/upgrading.md +++ b/docs/upgrading.md @@ -1,4 +1,7 @@ -# Upgrading LibreTime +--- +layout: docs +title: Upgrading LibreTime +--- ## LibreTime versioning diff --git a/docs/users.md b/docs/users.md index f3556f9b6..538c6a703 100644 --- a/docs/users.md +++ b/docs/users.md @@ -1,9 +1,9 @@ --- -sidebar: mainmenus +layout: docs +title: Managing Users +blurb: How to add, edit, and remove user accounts --- -# The Users page - > Note: if your Airtime server is accessible from the public Internet (ex. being hosted in a cloud VM) it is recommended that you create a second administrator account with a secure password and then delete the `admin` account, for best security practice.