From 7f024e5462a153278dc0f8b3409b2db9caa10e1f Mon Sep 17 00:00:00 2001 From: GrantMcLravy <69214295+GrantMcLravy@users.noreply.github.com> Date: Sat, 19 Aug 2023 23:54:00 -0400 Subject: [PATCH] Include the .md extension for relative links (#16) * updating tubearchivist/jellyfin to tubearchivist-jf * adding .md file extension * fixing /#, removing slash --- mkdocs/docs/faq.md | 6 +++--- mkdocs/docs/index.md | 8 ++++---- mkdocs/docs/installation/docker-compose.md | 2 +- mkdocs/docs/settings.md | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/mkdocs/docs/faq.md b/mkdocs/docs/faq.md index d07a68a..f35ecce 100644 --- a/mkdocs/docs/faq.md +++ b/mkdocs/docs/faq.md @@ -29,7 +29,7 @@ Although there are similarities between these excellent projects and Tube Archiv Part of the scope is to be its own media server, to be able to overcome these limitations, so that's where the focus and effort of this project is. That being said, the nature of self hosted and open source software gives you all the possible freedom to use your media as you wish. -- **Jellyfin**: There is an API to API integration available to sync metadata from Tube Archivist to Jellyfin: [tubearchivist/jellyfin](https://github.com/tubearchivist/jellyfin). Follow the instructions there. Please contribute to improve this integration. +- **Jellyfin**: There is an API to API integration available to sync metadata from Tube Archivist to Jellyfin: [tubearchivist/tubearchivist-jf](https://github.com/tubearchivist/tubearchivist-jf). Follow the instructions there. Please contribute to improve this integration. - **Plex**: Progress is happening on that... ## How do I install this natively? @@ -48,9 +48,9 @@ That might be an unconventional choice at first glance. Tube Archivist is built That comes at a price: ES can use a lot of memory, particularly on a big index, and will heavily use in memory cached queries to be able to respond within milliseconds, even when searching through multiple GBs of raw text. ## Why does subscribing to a channel not download the complete channel? -For Tube Archivist, these are two different things: To download a complete channel, add it to the [download queue](downloads/#add-to-download-queue) with the form or with [Tube Archivist Companion](https://github.com/tubearchivist/browser-extension), the browser extension. This is meant for a complete archival. +For Tube Archivist, these are two different things: To download a complete channel, add it to the [download queue](downloads.md#add-to-download-queue) with the form or with [Tube Archivist Companion](https://github.com/tubearchivist/browser-extension), the browser extension. This is meant for a complete archival. -Subscribing to a channel is for downloading new videos as they come out. That is designed to be as quick as possible, to allow you to efficiently rescan your favourite channels frequently. This will add videos to your download queue based on your [channel page size](settings/#subscriptions). +Subscribing to a channel is for downloading new videos as they come out. That is designed to be as quick as possible, to allow you to efficiently rescan your favourite channels frequently. This will add videos to your download queue based on your [channel page size](settings.md#subscriptions). If you want to archive the complete channel **and** any future videos, you can do both. diff --git a/mkdocs/docs/index.md b/mkdocs/docs/index.md index 5655f9d..f95577a 100644 --- a/mkdocs/docs/index.md +++ b/mkdocs/docs/index.md @@ -7,10 +7,10 @@ Welcome to the official Tube Archivist Docs. This is an up-to-date documentation ## Getting Started -1. [Subscribe](channels#channels-overview) to some of your favourite YouTube channels. -2. [Scan](downloads#rescan-subscriptions) subscriptions to add the latest videos to the download queue. -3. [Add](downloads#add-to-download-queue) additional videos, channels or playlist - ignore the ones you don't want to download. -4. [Download](downloads#download-queue) and let **Tube Archivist** do it's thing. +1. [Subscribe](channels.md#channels-overview) to some of your favourite YouTube channels. +2. [Scan](downloads.md#rescan-subscriptions) subscriptions to add the latest videos to the download queue. +3. [Add](downloads.md#add-to-download-queue) additional videos, channels or playlist - ignore the ones you don't want to download. +4. [Download](downloads.md#download-queue) and let **Tube Archivist** do it's thing. 5. Sit back and enjoy your archived and indexed collection! ## General Navigation diff --git a/mkdocs/docs/installation/docker-compose.md b/mkdocs/docs/installation/docker-compose.md index a39871d..d5187b2 100644 --- a/mkdocs/docs/installation/docker-compose.md +++ b/mkdocs/docs/installation/docker-compose.md @@ -22,7 +22,7 @@ The main Python application that displays and serves your video collection, buil - Change the environment variables `TA_USERNAME` and `TA_PASSWORD` to create the initial credentials. - `ELASTIC_PASSWORD` is for the password for Elasticsearch. The environment variable `ELASTIC_USER` is optional, should you want to change the username from the default *elastic*. - For the scheduler to know what time it is, set your timezone with the `TZ` environment variable, defaults to *UTC*. - - Set the environment variable `ENABLE_CAST=True` to send videos to your cast device, [read more](/configuration/cast/). + - Set the environment variable `ENABLE_CAST=True` to send videos to your cast device, [read more](../configuration/cast.md). ## Configuring TubeArchivist diff --git a/mkdocs/docs/settings.md b/mkdocs/docs/settings.md index 27d0b2f..3bff641 100644 --- a/mkdocs/docs/settings.md +++ b/mkdocs/docs/settings.md @@ -80,7 +80,7 @@ All third party integrations of TubeArchivist will **always** be *opt in*. - **API**: Your access token for the Tube Archivist API. - **returnyoutubedislike.com**: This will get return dislikes and average ratings for each video by integrating with the API from [returnyoutubedislike.com](https://www.returnyoutubedislike.com/). -- **SponsorBlock**: Using [SponsorBlock](https://sponsor.ajay.app/) to get and skip sponsored content. If a video doesn't have timestamps, or has unlocked timestamps, use the browser addon to contribute to this excellent project. Can also be activated and deactivated as a per [channel overwrite](Settings#channel-customize). +- **SponsorBlock**: Using [SponsorBlock](https://sponsor.ajay.app/) to get and skip sponsored content. If a video doesn't have timestamps, or has unlocked timestamps, use the browser addon to contribute to this excellent project. Can also be activated and deactivated as a per [channel overwrite](settings.md#channel-customize). ## Snapshots !!! note