Skip to content

Commit 462d157

Browse files
committed
Clarify media blurb
1 parent e0994d8 commit 462d157

3 files changed

Lines changed: 16 additions & 16 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Media folders
22

3-
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.
3+
We have set '{{ opt_param_volumes[0].vol_path | default("/movies, /tv or /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.
44

55
Use the optional paths if you don't understand, or don't want hardlinks/atomic moves.
66

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,6 @@ description: "{{ noter(project_blurb) | trim }}"
4040
{% if app_setup_block_enabled %}
4141
{% include "README_SNIPPETS/APPLICATION_SETUP.j2" | trim %}
4242

43-
{% if readonly_supported is defined and readonly_supported %}
44-
{% include "README_SNIPPETS/READONLY.j2" | trim %}
45-
46-
{% endif %}
47-
{% if nonroot_supported is defined and nonroot_supported %}
48-
{% include "README_SNIPPETS/NONROOT.j2" | trim %}
49-
5043
{% endif %}
5144
{% if ["CI_SSL='true'", "CI_SSL= 'true'" ,"CI_SSL = 'true'"]|select("in", repo_vars) %}
5245
{% include "README_SNIPPETS/STRICT_PROXY.j2" | trim %}
@@ -72,6 +65,13 @@ description: "{{ noter(project_blurb) | trim }}"
7265
{% include "README_SNIPPETS/KASM.j2" | trim %}
7366

7467
{% endif %}
68+
{% if readonly_supported is defined and readonly_supported %}
69+
{% include "README_SNIPPETS/READONLY.j2" | trim %}
70+
71+
{% endif %}
72+
{% if nonroot_supported is defined and nonroot_supported %}
73+
{% include "README_SNIPPETS/NONROOT.j2" | trim %}
74+
7575
{% endif %}
7676
{% include "README_SNIPPETS/USAGE.j2" | trim %}
7777

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,6 @@
3232
{% if app_setup_block_enabled %}
3333
{% include "README_SNIPPETS/APPLICATION_SETUP.j2" | trim %}
3434

35-
{% if readonly_supported is defined and readonly_supported %}
36-
{% include "README_SNIPPETS/READONLY.j2" | trim %}
37-
38-
{% endif %}
39-
{% if nonroot_supported is defined and nonroot_supported %}
40-
{% include "README_SNIPPETS/NONROOT.j2" | trim %}
41-
42-
{% endif %}
4335
{% if ["CI_SSL='true'", "CI_SSL= 'true'" ,"CI_SSL = 'true'"]|select("in", repo_vars) %}
4436
{% include "README_SNIPPETS/STRICT_PROXY.j2" | trim %}
4537

@@ -63,6 +55,14 @@
6355
{% if kasm_blurb is defined %}
6456
{% include "README_SNIPPETS/KASM.j2" | trim %}
6557

58+
{% endif %}
59+
{% if readonly_supported is defined and readonly_supported %}
60+
{% include "README_SNIPPETS/READONLY.j2" | trim %}
61+
62+
{% endif %}
63+
{% if nonroot_supported is defined and nonroot_supported %}
64+
{% include "README_SNIPPETS/NONROOT.j2" | trim %}
65+
6666
{% endif %}
6767
{% endif %}
6868
{% include "README_SNIPPETS/USAGE.j2" | trim %}

0 commit comments

Comments
 (0)