update docs

torchbox · Mar 22, 2024 · c590912 · c590912
1 parent a71a08c
commit c590912
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/docs/front-end/lite-youtube.md b/docs/front-end/lite-youtube.md
@@ -0,0 +1,7 @@
+# Lite youtube
+
+We use the https://www.npmjs.com/package/lite-youtube-embed package to avoid setting youtube cookies, along with https://theorangeone.net/projects/wagtail-lite-youtube-embed/
+
+When youtube videos are first loaded the user must accept the youtube Ts and Cs. They can opt not to show them again - this sets a cookie to hide the consent message in future.
+
+This functionality is controlled by `tbx/static_src/javascript/components/youtube-embed.js`.
diff --git a/docs/front-end/sustainability.md b/docs/front-end/sustainability.md
@@ -9,3 +9,5 @@ We use dark mode by default.
 All images should be renedered in the template file as webp format using the `format-webp` attribute - see https://docs.wagtail.org/en/v5.2.2/advanced_topics/images/image_file_formats.html.
 
 We have a custom saturation filter that allows us to apply a slight desaturation to all images using `saturation-0.6` - this makes the file size of images smaller overall, as well as creating a cohesive look for photographic images.
+
+Youtube videos are not loaded by default. Instead they show a placeholder image and a play button, and only load when the user clicks 'play'.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -72,6 +72,7 @@ nav:
       - front-end/placeholder-images.md
       - front-end/utility-classes.md
       - 'Markdown block and codehilite': 'front-end/markdown-codehilite.md'
+      - front-end/lite-youtube.md
   - 'Navigation': 'navigation.md'
   - 'Custom features':
       - 'Migration-friendly StreamFields': 'custom-features/migration-friendly-streamfields.md'
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,3 +9,5 @@ We use dark mode by default.
		All images should be renedered in the template file as webp format using the `format-webp` attribute - see https://docs.wagtail.org/en/v5.2.2/advanced_topics/images/image_file_formats.html.

		We have a custom saturation filter that allows us to apply a slight desaturation to all images using `saturation-0.6` - this makes the file size of images smaller overall, as well as creating a cohesive look for photographic images.

		Youtube videos are not loaded by default. Instead they show a placeholder image and a play button, and only load when the user clicks 'play'.