From 0c791d870d02450db5bd191a8184f4f66a03d6e0 Mon Sep 17 00:00:00 2001 From: Zachary Klosko <31484611+zklosko@users.noreply.github.com> Date: Tue, 12 May 2020 21:28:15 -0400 Subject: [PATCH] Reorganizing tutorials and creating appendix --- docs/_config.yml | 4 ++-- docs/appendix.md | 6 ++++++ .../index.md => appx/about-manual.md} | 0 .../index.md => appx/hd-audio-models.md} | 0 .../index.md => appx/rights-royalties.md} | 0 docs/config.md | 16 ---------------- docs/tutorials.md | 12 ++++++++++++ docs/{config => tuts}/host-configuration.md | 0 docs/{config => tuts}/icecast-handover/index.md | 0 .../static/Screenshot123-Mixxx_Preferences.png | Bin .../interface-customization/index.md | 0 .../static/Screenshot177-Icecast_rocks.png | Bin .../interface-localization/index.md | 0 .../Screenshot464-Korean_stream_setting.png | Bin docs/{config => tuts}/piwik/index.md | 0 .../piwik/static/Screenshot550-Pwik_setup.png | Bin .../piwik/static/Screenshot551-Piwik_map.png | Bin docs/{config => tuts}/promoting-your-station.md | 0 .../secure-login-with-ssl/index.md | 0 .../Screenshot547-connection_untrusted.png | Bin .../static/Screenshot548-confirm_exception.png | Bin .../Screenshot549-unencrypted_warning.png | Bin .../setting-the-server-time/index.md | 0 .../static/Screenshot15-Configuring_tzdata.png | Bin .../static/Screenshot16-Configure_city.png | Bin 25 files changed, 20 insertions(+), 18 deletions(-) create mode 100644 docs/appendix.md rename docs/{manual/about-this-manual/index.md => appx/about-manual.md} (100%) rename docs/{manual/hd-audio-models/index.md => appx/hd-audio-models.md} (100%) rename docs/{manual/rights-and-royalties/index.md => appx/rights-royalties.md} (100%) delete mode 100644 docs/config.md rename docs/{config => tuts}/host-configuration.md (100%) rename docs/{config => tuts}/icecast-handover/index.md (100%) rename docs/{config => tuts}/icecast-handover/static/Screenshot123-Mixxx_Preferences.png (100%) rename docs/{config => tuts}/interface-customization/index.md (100%) rename docs/{config => tuts}/interface-customization/static/Screenshot177-Icecast_rocks.png (100%) rename docs/{config => tuts}/interface-localization/index.md (100%) rename docs/{config => tuts}/interface-localization/static/Screenshot464-Korean_stream_setting.png (100%) rename docs/{config => tuts}/piwik/index.md (100%) rename docs/{config => tuts}/piwik/static/Screenshot550-Pwik_setup.png (100%) rename docs/{config => tuts}/piwik/static/Screenshot551-Piwik_map.png (100%) rename docs/{config => tuts}/promoting-your-station.md (100%) rename docs/{config => tuts}/secure-login-with-ssl/index.md (100%) rename docs/{config => tuts}/secure-login-with-ssl/static/Screenshot547-connection_untrusted.png (100%) rename docs/{config => tuts}/secure-login-with-ssl/static/Screenshot548-confirm_exception.png (100%) rename docs/{config => tuts}/secure-login-with-ssl/static/Screenshot549-unencrypted_warning.png (100%) rename docs/{config => tuts}/setting-the-server-time/index.md (100%) rename docs/{config => tuts}/setting-the-server-time/static/Screenshot15-Configuring_tzdata.png (100%) rename docs/{config => tuts}/setting-the-server-time/static/Screenshot16-Configure_city.png (100%) diff --git a/docs/_config.yml b/docs/_config.yml index 3cdf18f09..aae47fdc8 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -16,7 +16,7 @@ navigation: url: faq - text: Tutorials url: tutorials -- text: Config - url: config +- text: Appendix + url: appendix - text: Help! url: troubleshooting \ No newline at end of file diff --git a/docs/appendix.md b/docs/appendix.md new file mode 100644 index 000000000..a0c112e08 --- /dev/null +++ b/docs/appendix.md @@ -0,0 +1,6 @@ +Appendix +--------- + +* [About this manual](appx/about-manual) +* [HD Audio Module information](appx/hd-audio-modules) +* [Rights and royalty information](appx/rights-royalties) \ No newline at end of file diff --git a/docs/manual/about-this-manual/index.md b/docs/appx/about-manual.md similarity index 100% rename from docs/manual/about-this-manual/index.md rename to docs/appx/about-manual.md diff --git a/docs/manual/hd-audio-models/index.md b/docs/appx/hd-audio-models.md similarity index 100% rename from docs/manual/hd-audio-models/index.md rename to docs/appx/hd-audio-models.md diff --git a/docs/manual/rights-and-royalties/index.md b/docs/appx/rights-royalties.md similarity index 100% rename from docs/manual/rights-and-royalties/index.md rename to docs/appx/rights-royalties.md diff --git a/docs/config.md b/docs/config.md deleted file mode 100644 index bef0f070b..000000000 --- a/docs/config.md +++ /dev/null @@ -1,16 +0,0 @@ -# Config - -This section includes information on how to configure LibreTime. - -## Initial Configuration (Please complete these after installing LibreTime) -* [Host Configuration](config/host-configuration) -* [Setting the server time](config/setting-the-server-time/index) - - -## Advanced Configuration -* [Interface Customization](config/interface-customization/index) -* [Localization Settings](config/interface-localization/index) -* [Setting up SSL](config/secure-login-with-ssl) -* [Promoting your station through your Icecast stream](config/promoting-your-station) -* [Configuring Icecast handover](config/icecast-handover/index) -* [Configuring Icecast statistics with Piwik](config/piwik/index) \ No newline at end of file diff --git a/docs/tutorials.md b/docs/tutorials.md index 10b6512b6..d74cb040e 100644 --- a/docs/tutorials.md +++ b/docs/tutorials.md @@ -48,11 +48,23 @@ There are also a number of tutorials in Spanish on [Vimeo](https://vimeo.com/use * [How to export a schedule of played tracks](tuts/exporting-the-schedule/index) ## For Server Administrators + +### Initial Configuration (Please complete these after installing LibreTime) +* [Host Configuration](tuts/host-configuration) +* [Setting the server time](tuts/setting-the-server-time/index) * [How to configure API Authentication](api) + +### Advanced Configuration * [Installing LibreTime from Git on a stand-alone VPS](tuts/install-vps) * [Securing icecast and customizing stream settings ](tuts/stream-settings) * [How to install player and calendar widgets on your website](tuts/widgets) * [Configuring track types](tuts/track-types) +* [Interface Customization](tuts/interface-customization/index) +* [Localization Settings](tuts/interface-localization/index) +* [Setting up SSL](tuts/secure-login-with-ssl) +* [Promoting your station through your Icecast stream](tuts/promoting-your-station) +* [Configuring Icecast handover](tuts/icecast-handover/index) +* [Configuring Icecast statistics with Piwik](tuts/piwik/index) * [How to back up the LibreTime media folder and database](tuts/backing-up-the-server/index) * [Upgrading LibreTime](tuts/upgrading/index) * [Uninstalling LibreTime](tuts/uninstall) diff --git a/docs/config/host-configuration.md b/docs/tuts/host-configuration.md similarity index 100% rename from docs/config/host-configuration.md rename to docs/tuts/host-configuration.md diff --git a/docs/config/icecast-handover/index.md b/docs/tuts/icecast-handover/index.md similarity index 100% rename from docs/config/icecast-handover/index.md rename to docs/tuts/icecast-handover/index.md diff --git a/docs/config/icecast-handover/static/Screenshot123-Mixxx_Preferences.png b/docs/tuts/icecast-handover/static/Screenshot123-Mixxx_Preferences.png similarity index 100% rename from docs/config/icecast-handover/static/Screenshot123-Mixxx_Preferences.png rename to docs/tuts/icecast-handover/static/Screenshot123-Mixxx_Preferences.png diff --git a/docs/config/interface-customization/index.md b/docs/tuts/interface-customization/index.md similarity index 100% rename from docs/config/interface-customization/index.md rename to docs/tuts/interface-customization/index.md diff --git a/docs/config/interface-customization/static/Screenshot177-Icecast_rocks.png b/docs/tuts/interface-customization/static/Screenshot177-Icecast_rocks.png similarity index 100% rename from docs/config/interface-customization/static/Screenshot177-Icecast_rocks.png rename to docs/tuts/interface-customization/static/Screenshot177-Icecast_rocks.png diff --git a/docs/config/interface-localization/index.md b/docs/tuts/interface-localization/index.md similarity index 100% rename from docs/config/interface-localization/index.md rename to docs/tuts/interface-localization/index.md diff --git a/docs/config/interface-localization/static/Screenshot464-Korean_stream_setting.png b/docs/tuts/interface-localization/static/Screenshot464-Korean_stream_setting.png similarity index 100% rename from docs/config/interface-localization/static/Screenshot464-Korean_stream_setting.png rename to docs/tuts/interface-localization/static/Screenshot464-Korean_stream_setting.png diff --git a/docs/config/piwik/index.md b/docs/tuts/piwik/index.md similarity index 100% rename from docs/config/piwik/index.md rename to docs/tuts/piwik/index.md diff --git a/docs/config/piwik/static/Screenshot550-Pwik_setup.png b/docs/tuts/piwik/static/Screenshot550-Pwik_setup.png similarity index 100% rename from docs/config/piwik/static/Screenshot550-Pwik_setup.png rename to docs/tuts/piwik/static/Screenshot550-Pwik_setup.png diff --git a/docs/config/piwik/static/Screenshot551-Piwik_map.png b/docs/tuts/piwik/static/Screenshot551-Piwik_map.png similarity index 100% rename from docs/config/piwik/static/Screenshot551-Piwik_map.png rename to docs/tuts/piwik/static/Screenshot551-Piwik_map.png diff --git a/docs/config/promoting-your-station.md b/docs/tuts/promoting-your-station.md similarity index 100% rename from docs/config/promoting-your-station.md rename to docs/tuts/promoting-your-station.md diff --git a/docs/config/secure-login-with-ssl/index.md b/docs/tuts/secure-login-with-ssl/index.md similarity index 100% rename from docs/config/secure-login-with-ssl/index.md rename to docs/tuts/secure-login-with-ssl/index.md diff --git a/docs/config/secure-login-with-ssl/static/Screenshot547-connection_untrusted.png b/docs/tuts/secure-login-with-ssl/static/Screenshot547-connection_untrusted.png similarity index 100% rename from docs/config/secure-login-with-ssl/static/Screenshot547-connection_untrusted.png rename to docs/tuts/secure-login-with-ssl/static/Screenshot547-connection_untrusted.png diff --git a/docs/config/secure-login-with-ssl/static/Screenshot548-confirm_exception.png b/docs/tuts/secure-login-with-ssl/static/Screenshot548-confirm_exception.png similarity index 100% rename from docs/config/secure-login-with-ssl/static/Screenshot548-confirm_exception.png rename to docs/tuts/secure-login-with-ssl/static/Screenshot548-confirm_exception.png diff --git a/docs/config/secure-login-with-ssl/static/Screenshot549-unencrypted_warning.png b/docs/tuts/secure-login-with-ssl/static/Screenshot549-unencrypted_warning.png similarity index 100% rename from docs/config/secure-login-with-ssl/static/Screenshot549-unencrypted_warning.png rename to docs/tuts/secure-login-with-ssl/static/Screenshot549-unencrypted_warning.png diff --git a/docs/config/setting-the-server-time/index.md b/docs/tuts/setting-the-server-time/index.md similarity index 100% rename from docs/config/setting-the-server-time/index.md rename to docs/tuts/setting-the-server-time/index.md diff --git a/docs/config/setting-the-server-time/static/Screenshot15-Configuring_tzdata.png b/docs/tuts/setting-the-server-time/static/Screenshot15-Configuring_tzdata.png similarity index 100% rename from docs/config/setting-the-server-time/static/Screenshot15-Configuring_tzdata.png rename to docs/tuts/setting-the-server-time/static/Screenshot15-Configuring_tzdata.png diff --git a/docs/config/setting-the-server-time/static/Screenshot16-Configure_city.png b/docs/tuts/setting-the-server-time/static/Screenshot16-Configure_city.png similarity index 100% rename from docs/config/setting-the-server-time/static/Screenshot16-Configure_city.png rename to docs/tuts/setting-the-server-time/static/Screenshot16-Configure_city.png