From 2754c26f2e022b623e46e08fc1108b350710ef91 Mon Sep 17 00:00:00 2001 From: Mark Fulton <128738155+markunl@users.noreply.github.com> Date: Wed, 11 Oct 2023 15:20:16 -0400 Subject: [PATCH] docs/video embed, academy video embed fixes (#5005) PR contains the following: 1) New video embeds for the following docs: - website/docs/reference/deploy/environment-import-export.mdx - website/docs/reference/playground.mdx - website/docs/reference/strategy-constraints.md - website/docs/topics/a-b-testing.md 2) Improvements to the Academy course playlist embedding for the three Academy courses. Tested the standard method of embedding video, and it seems this works well for playlists too. Switching to the native Docusaurus embed solves the issue with dynamic resizing. Rather than a static embed size the video will now scale to the browser window size. --- .../docs/reference/deploy/environment-import-export.mdx | 4 ++++ website/docs/reference/playground.mdx | 4 ++++ website/docs/reference/strategy-constraints.md | 4 ++++ website/docs/topics/a-b-testing.md | 4 ++++ website/docs/tutorials/academy-advanced-for-devs.md | 8 +++++--- website/docs/tutorials/academy-foundational.md | 6 +++--- .../docs/tutorials/academy-managing-unleash-for-devops.md | 6 ++++-- 7 files changed, 28 insertions(+), 8 deletions(-) diff --git a/website/docs/reference/deploy/environment-import-export.mdx b/website/docs/reference/deploy/environment-import-export.mdx index 6a61b13701b1..83be3d99989f 100644 --- a/website/docs/reference/deploy/environment-import-export.mdx +++ b/website/docs/reference/deploy/environment-import-export.mdx @@ -1,6 +1,7 @@ --- title: Environment Import & Export --- +import VideoContent from '@site/src/components/VideoContent.jsx' :::info Availability @@ -8,6 +9,9 @@ The environment import and export first appeared in Unleash 4.22.0. ::: + + + Environment export and import lets you copy feature configurations from one environment to another and even copy features from one Unleash instance to another. When exporting, you select a set of features and **one** environment to export the configuration from. The environment must be the same for all features. diff --git a/website/docs/reference/playground.mdx b/website/docs/reference/playground.mdx index b1731525048b..e96515b31f09 100644 --- a/website/docs/reference/playground.mdx +++ b/website/docs/reference/playground.mdx @@ -2,6 +2,7 @@ title: The Playground --- import Figure from '@site/src/components/Figure/Figure.tsx' +import VideoContent from '@site/src/components/VideoContent.jsx' :::info Availability @@ -9,6 +10,9 @@ The Unleash playground is available in all Unleash versions from Unleash 4.14 on ::: + + + ![The Unleash Playground form and an indication of where in the nav menu it is located.](/img/playground-form.png) The unleash playground is a part of the Unleash Admin UI and an accompanying API. The playground lets you see which of your instance's feature toggles would be enabled for a given Unleash context. It has multiple uses, such as: diff --git a/website/docs/reference/strategy-constraints.md b/website/docs/reference/strategy-constraints.md index dac0a75b419c..afe1e0093cb4 100644 --- a/website/docs/reference/strategy-constraints.md +++ b/website/docs/reference/strategy-constraints.md @@ -1,6 +1,7 @@ --- title: Strategy Constraints --- +import VideoContent from '@site/src/components/VideoContent.jsx' :::info Availability @@ -30,6 +31,9 @@ You can constrain both on [standard context fields](../reference/unleash-context This page explains what strategy constraints are in Unleash and how they work. If you want to know *how you add* strategy constraints to an activation strategy, see [the corresponding how-to guide](../how-to/how-to-add-strategy-constraints.md "how to add strategy constraints"). + + + ## Constraining on custom context fields :::info Making custom context fields available diff --git a/website/docs/topics/a-b-testing.md b/website/docs/topics/a-b-testing.md index e1c7a0e0acc4..0d5a870f35f7 100644 --- a/website/docs/topics/a-b-testing.md +++ b/website/docs/topics/a-b-testing.md @@ -1,6 +1,7 @@ --- title: A/B and multivariate testing --- +import VideoContent from '@site/src/components/VideoContent.jsx' A/B testing is a type of randomized controlled experiment, where you test two different versions of a feature to see which version performs better. If you have more than two versions, it's known as _multivariate testing_. Coupled with analytics, A/B and multivariate testing enables you to better understand your users and how you can serve them better. @@ -8,6 +9,9 @@ To facilitate A/B testing and experimentation, Unleash has a built-in 'experimen In the rest of this document, _A/B testing_ will refer to both strict A/B testing and multivariate testing unless otherwise specified. + + + ## What is A/B testing [According to Wikipedia](https://en.wikipedia.org/wiki/A/B_testing), A/B testing is a user experience research methodology. They're useful for understanding user engagement and satisfaction. diff --git a/website/docs/tutorials/academy-advanced-for-devs.md b/website/docs/tutorials/academy-advanced-for-devs.md index c8ac07213fd6..1bfab88546d0 100644 --- a/website/docs/tutorials/academy-advanced-for-devs.md +++ b/website/docs/tutorials/academy-advanced-for-devs.md @@ -2,6 +2,8 @@ id: academy-advanced-for-devs title: Advanced for Developers --- +import VideoContent from '@site/src/components/VideoContent.jsx' + :::info **This Unleash Academy course is for all developer roles working with Unleash, after Foundational content has been reviewed.** ::: @@ -23,9 +25,9 @@ You’ll master advanced use cases and implement best practices - this course wi ## Course Detail - - - + + + :::info Embedded Player The full course is shown above. Click the icon in the top right corner of the embedded player to view your progress as you work through the videos. diff --git a/website/docs/tutorials/academy-foundational.md b/website/docs/tutorials/academy-foundational.md index 0441b3a5be84..af3bc1f7d289 100644 --- a/website/docs/tutorials/academy-foundational.md +++ b/website/docs/tutorials/academy-foundational.md @@ -2,6 +2,8 @@ id: academy-foundational title: Foundational --- +import VideoContent from '@site/src/components/VideoContent.jsx' + :::info **This Unleash Academy course is for all roles working with Unleash - Developers, Product owners, Leaders.** ::: @@ -42,9 +44,7 @@ An understanding of Unleash anatomy and architecture and how the different syste ## Course Detail - - - + :::info Embedded Player diff --git a/website/docs/tutorials/academy-managing-unleash-for-devops.md b/website/docs/tutorials/academy-managing-unleash-for-devops.md index e540d273d6a1..a1d98a8c6e2a 100644 --- a/website/docs/tutorials/academy-managing-unleash-for-devops.md +++ b/website/docs/tutorials/academy-managing-unleash-for-devops.md @@ -2,6 +2,8 @@ id: academy-managing-unleash-for-devops title: Managing Unleash for DevOps/Admins --- +import VideoContent from '@site/src/components/VideoContent.jsx' + :::info **This Unleash Academy course is for all DevOps and Admin roles working with Unleash, after Foundational content has been reviewed.** ::: @@ -23,9 +25,9 @@ Understand how to deploy Unleash in a secure and performant manner through Edge, ## Course Detail - - + + :::info Embedded Player The full course is shown above. Click the icon in the top right corner of the embedded player to view your progress as you work through the videos.