Merge pull request #332 from linuxserver/monthly-media

Clarify media blurb

Author: Roxedus

ansible/roles/documentation/templates/README_SNIPPETS/MEDIA.j2

@@ -1,7 +1,8 @@
 ### Media folders
+{% set has_media_path=((opt_param_volumes[0].vol_path | default("yes")) != "/downloads") %}
 
-We have set /music and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
+We have set {% if has_media_path %}`{{ opt_param_volumes[0].vol_path | default("/movies, /tv or /music") }}` and {% endif %}`/downloads` as optional path{% if has_media_path %}s{% endif %}, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
 
-Use the optional paths if you don't understand, or don't want hardlinks/atomic moves.
+Use the optional path{% if has_media_path %}s{% endif %} if you don't understand, or don't want hardlinks/atomic moves.
 
 {{  "The folks over at servarr.com wrote a good [write-up](https://wiki.servarr.com/docker-guide#consistent-and-well-planned-paths) on how to get started with this." | admonition(flavour=markdown, severity="tip", title="Well planned paths", collapse=False) }}

ansible/roles/documentation/templates/documentation.md.j2

@@ -40,13 +40,6 @@ description: "{{ noter(project_blurb) | trim }}"
 {% if app_setup_block_enabled %}
 {% include "README_SNIPPETS/APPLICATION_SETUP.j2" | trim %}
 
-{% if readonly_supported is defined and readonly_supported %}
-{% include "README_SNIPPETS/READONLY.j2" | trim %}
-
-{% endif %}
-{% if nonroot_supported is defined and nonroot_supported %}
-{% include "README_SNIPPETS/NONROOT.j2" | trim %}
-
 {% endif %}
 {% if ["CI_SSL='true'", "CI_SSL= 'true'" ,"CI_SSL = 'true'"]|select("in", repo_vars) %}
 {% include "README_SNIPPETS/STRICT_PROXY.j2" | trim %}
@@ -72,6 +65,13 @@ description: "{{ noter(project_blurb) | trim }}"
 {% include "README_SNIPPETS/KASM.j2" | trim %}
 
 {% endif %}
+{% if readonly_supported is defined and readonly_supported %}
+{% include "README_SNIPPETS/READONLY.j2" | trim %}
+
+{% endif %}
+{% if nonroot_supported is defined and nonroot_supported %}
+{% include "README_SNIPPETS/NONROOT.j2" | trim %}
+
 {% endif %}
 {% include "README_SNIPPETS/USAGE.j2" | trim %}
 

ansible/roles/documentation/templates/readme.md.j2

@@ -32,14 +32,6 @@
 {% if app_setup_block_enabled %}
 {% include "README_SNIPPETS/APPLICATION_SETUP.j2" | trim %}
 
-{% if readonly_supported is defined and readonly_supported %}
-{% include "README_SNIPPETS/READONLY.j2" | trim %}
-
-{% endif %}
-{% if nonroot_supported is defined and nonroot_supported %}
-{% include "README_SNIPPETS/NONROOT.j2" | trim %}
-
-{% endif %}
 {% if ["CI_SSL='true'", "CI_SSL= 'true'" ,"CI_SSL = 'true'"]|select("in", repo_vars) %}
 {% include "README_SNIPPETS/STRICT_PROXY.j2" | trim %}
 
@@ -63,6 +55,14 @@
 {% if kasm_blurb is defined %}
 {% include "README_SNIPPETS/KASM.j2" | trim %}
 
+{% endif %}
+{% if readonly_supported is defined and readonly_supported %}
+{% include "README_SNIPPETS/READONLY.j2" | trim %}
+
+{% endif %}
+{% if nonroot_supported is defined and nonroot_supported %}
+{% include "README_SNIPPETS/NONROOT.j2" | trim %}
+
 {% endif %}
 {% endif %}
 {% include "README_SNIPPETS/USAGE.j2" | trim %}