Documentation improvements: Audit Trail/Redis/SEO/Deployment docs, demo videos, YouTube embed privacy (Lombiq Technologies: OCORE-78)

mkdocs.yml

@@ -135,6 +135,7 @@ nav:
               - Flow: docs/reference/modules/Flow/README.md
               - Bag: docs/reference/modules/Flow/BagPart.md
               - Publish Later: docs/reference/modules/PublishLater/README.md
+              - SEO Meta: docs/reference/modules/Seo/README.md
           - Content Fields: docs/reference/modules/ContentFields/README.md
           - Content Preview: docs/reference/modules/ContentPreview/README.md
           - Content Localization: docs/reference/modules/ContentLocalization/README.md
@@ -178,12 +179,14 @@ nav:
           - Home Route: docs/reference/modules/HomeRoute/README.md
           - Feeds: docs/reference/modules/Feeds/README.md
       - Core Modules:
+          - Audit Trail: docs/reference/modules/AuditTrail/README.md
           - Auto Setup: docs/reference/modules/AutoSetup/README.md
           - Features: docs/reference/modules/Features/README.md
           - Contents: docs/reference/modules/Contents/README.md
           - Configuration: docs/reference/core/Configuration/README.md
           - Cors: docs/reference/modules/Cors/README.md
           - Custom Settings: docs/reference/modules/CustomSettings/README.md
+          - Deployment: docs/reference/modules/Deployment/README.md
           - Placement: docs/reference/core/Placement/README.md
           - Data: docs/reference/core/Data/README.md
           - Data Migrations: docs/reference/modules/Migrations/README.md
@@ -201,6 +204,8 @@ nav:
           - OpenId: docs/reference/modules/OpenId/README.md
           - Razor Helpers: docs/reference/core/Razor/README.md
           - Recipes: docs/reference/modules/Recipes/README.md
+          - Redis: docs/reference/modules/Redis/README.md
+          - Remote Deployment: docs/reference/modules/Deployment.Remote/README.md
           - Response Compression: docs/reference/modules/ResponseCompression/README.md
           - Roles: docs/reference/modules/Roles/README.md
           - Sanitizer: docs/reference/core/Sanitizer/README.md

src/OrchardCore.Build/OrchardCore.Commons.props

@@ -28,25 +28,25 @@
     <!--This is used to generate symbol package for Source Link-->
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
-    
+
     <!-- This is used by GitHub Repository to find which repository should contain the package when updloaded -->
     <RepositoryUrl>https://github.com/OrchardCMS/OrchardCore</RepositoryUrl>
     <PackageProjectUrl>https://www.orchardcore.net/</PackageProjectUrl>
     <PackageLicenseExpression>BSD-3-Clause</PackageLicenseExpression>
-    
+
     <PackageTags>OrchardCore</PackageTags>
     <Copyright>Orchard Core Community and Contributors</Copyright>
     <Authors>Orchard Core Community and Contributors</Authors>
     <Owners>Orchard Core Community and Contributors</Owners>
   </PropertyGroup>
 
   <ItemGroup>
-      <!--This is used for Source Link -->
-       <PackageReference Include="Microsoft.SourceLink.GitHub" PrivateAssets="All"/>
-      <None Include="$(MSBuildThisFileDirectory)/nuget-icon.png">
-        <Pack>True</Pack>
-        <PackagePath>icon.png</PackagePath>
-      </None>
+    <!--This is used for Source Link -->
+    <PackageReference Include="Microsoft.SourceLink.GitHub" PrivateAssets="All"/>
+    <None Include="$(MSBuildThisFileDirectory)/nuget-icon.png">
+      <Pack>True</Pack>
+      <PackagePath>icon.png</PackagePath>
+    </None>
   </ItemGroup>
 
 </Project>

src/README.md

@@ -97,3 +97,7 @@ For more details on the various development tools we recommend for using with Or
 - Run `docker run --name orchardcms orchardproject/orchardcore-cms-linux:latest`
 
 Docker images and parameters can be found at <https://hub.docker.com/u/orchardproject/>
+
+## Showcasing Orchard Core CMS
+
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/Gfy5SCACyL8" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

src/docs/getting-started/starter-recipes.md

@@ -31,19 +31,18 @@ Orchard Core Display Management techniques to render content.
 
 ## OrchardCore.Application.Cms.Core.Targets
 
-### Empty Recipe
+### Blank Recipe
 
-The Empty recipe enables content management features, but does not set a current theme.
+The Blank recipe enables content management features, but does not set a current theme.
 You can use this recipe when starting Orchard Core in Decoupled Mode,
 or when building your own theme.
 
 Alternatively you can start with another recipe,
 and change the active theme after setup.
 
-#### Empty Recipe Contents 
+#### Blank Recipe Contents 
 
 - Content management features
-- Enables templating via Liquid
 - Activates `TheAdmin` theme
 
 ### Headless Recipe
@@ -62,6 +61,10 @@ as an API, and Content Management System, with Administrator access to the host.
     You will want to review the default security configuration to be certain
     it suits your requirements.
 
+## Headless Recipe Video
+
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/dbABI1wECPg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+
 ## OrchardCore.Application.Cms.Targets
 
 ### TheBlogTheme and Blog Recipe

src/docs/guides/decoupled-cms/README.md

@@ -387,3 +387,7 @@ In this tutorial we have learned how to
 - Create Razor Pages with custom routes to render then content
 - Load content items with different identifiers
 - Render wysiwyg preview screens while editing the content
+
+## Video
+
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/yWpz8p-oaKg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

src/docs/reference/README.md

@@ -22,6 +22,7 @@ Here's a categorized overview of all built-in Orchard Core features at a glance.
 
 ### App security
 
+- [Audit Trail](modules/AuditTrail/README.md)
 - [CORS](modules/Cors/README.md)
 - [ReCaptcha](modules/ReCaptcha/README.md)
 - [Sanitizer](core/Sanitizer/README.md) 
@@ -55,6 +56,7 @@ Here's a categorized overview of all built-in Orchard Core features at a glance.
   - [Flow](modules/Flow/README.md) 
   - [Bag](modules/Flow/BagPart.md)
   - [Publish Later](modules/PublishLater/README.md)
+  - [SEO Meta](modules/Seo/README.md)
 - [Content Fields](modules/ContentFields/README.md)
 - [Content Preview](modules/ContentPreview/README.md)
 - [Taxonomies](modules/Taxonomies/README.md)
@@ -109,6 +111,9 @@ Here's a categorized overview of all built-in Orchard Core features at a glance.
 - [Mini Profiler](modules/MiniProfiler/README.md)
 - [Response Compression](modules/ResponseCompression/README.md)
 - [Email](modules/Email/README.md)
+- [Redis](modules/Redis/README.md)
+- [Deployment](modules/Deployment/README.md)
+- [Remote Deployment](modules/Deployment.Remote/README.md)
 
 ### Localization
 

src/docs/reference/core/Placement/README.md

@@ -310,4 +310,4 @@ We also specify that the `Content` column will take 9 columns, of the default 12
 
 ## Video
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/h0lZMQkUApo" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/h0lZMQkUApo" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

src/docs/reference/modules/AdminDashboard/README.md

@@ -4,8 +4,8 @@ The Admin Dashboard module provides a customizable admin dashboard for your site
 
 ## Widgets
 
-#### Videos
+### Videos
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/MQuiXEnyEBw" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/MQuiXEnyEBw" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/c7aiCPi2-BM" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/c7aiCPi2-BM" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

src/docs/reference/modules/AuditTrail/README.md

@@ -0,0 +1,58 @@
+# Audit Trail (`OrchardCore.AuditTrail`)
+
+The Audit Trail module provides an immutable (for users, even administrators but not for developers), auditable log of certain changes and events in the system. This includes e.g. creation or deletion of content items, and events like user login failures. For content items, previous versions and deleted items can be restored, changes tracked.
+
+## General Concepts
+
+Audit Trail events are created if a certain supported event happened in the system. While there are several built-in event handlers for the most important events, this is extensible and module authors can provide their own ones.
+
+Once you've enabled the module, you will see a new menu item in the admin UI called *Audit Trail*. The list there shows you the logged Audit Trail events.
+
+## Using the Audit Trail event list
+
+The Audit Trail event list provides you with filtering and pagination to be able to easily find the Audit Trail events that you are looking for. By default, you can filter by the following criteria:
+
+- a given date range,
+- categories (e.g. *All categories*, *Content*, *User*).
+
+You can also sort entries by various parameters.
+
+Events provide various details on their line:
+
+- The category and type of event (e.g. *Content* and *Published*).
+- The time when the event was recorded.
+- The user initiating the event.
+- An event-specific quick summary, if any. E.g. events of the *Content* category show you the version and title of the content item. If you click on the *Version X* link you can see the read-only editor of the content item filled with the values that the content item has at that version. If you click on the display text of the content item, you can edit the latest version of the content item.
+- Event-specific buttons, if any. E.g. events of the *Content* category will display a *View* button that you can use to view the content item at the given version, and a *Restore* button that you can use to restore the content item to the version even if the item was deleted (the restored item will be created as a draft version that you then need to publish).
+- A *Details* link. Here you can get more general information about the given event, as well as event handlers can provide custom information. E.g. if you check out the Detail view of a *Content* event you can also see the textual differences between the current version of the content item and the previous version under the *Diff* tab. The values of the current version will be shown in green, and the values of the previous version will be shown in red.
+
+## Audit Trail Settings 
+
+If you navigate to Configuration -> Settings -> Audit Trail, you will see various configuration options, depending on the enabled Audit Trail features:
+
+- A list that contains every event that you can record using the Audit Trail module. Here you can enable or disable the recording of the given events.
+- You can enable client IP address logging. When you enable this, the client IP address will be recorded in Audit Trail events. Note that depending on the legislation your site operates in, you need to take special care to collect and store such Personal Identifiable Information.
+- The *Trimming* settings are about configuring how long you would like to keep the Audit Trail events in the database. You can disable trimming if you would like to keep the events indefinitely.
+- Further tabs can be added. E.g. the *Content* tab allows you to select items of which content types you want to record Audit Trail events for.
+
+## Audit Trail Part
+
+You can attach the `AuditTrailPart` content part to your content type. This will allow content editors to enter a comment to be saved into the Audit Trail event when saving a content item. This will then be visible in the Audit Trail event list.
+
+## Recording Custom Events
+
+Orchard Core is built to be extended, and the Audit Trail module is no different. When creating your own module, you can log your events with Audit Trail too. Check out the source of the `OrchardCore.Users` or `OrchardCore.Contents` modules for examples.
+
+## Videos
+
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/ko0jEgQtXYc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/t28rnjYtlJc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+
+## CREDITS
+
+### jsdiff
+
+<https://github.com/kpdecker/jsdiff>  
+Copyright (c) 2009-2015, Kevin Decker, <[email protected]>  
+License: Software License Agreement (BSD License)

src/docs/reference/modules/ContentFields/README.md

@@ -238,14 +238,14 @@ When adding the field to a content type, use the settings to specify whether to
 
 #### Video
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/vqXwK69vtMw" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/vqXwK69vtMw" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 
 
 ### `MultiText Field`
 
 #### Video
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/WfP_rXz1id0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/WfP_rXz1id0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 
 ## Creating Custom Fields
 

src/docs/reference/modules/ContentParts/README.md

@@ -22,3 +22,5 @@ Orchard Core allows you to add Parts to a content type.
 | [`Preview`](../../modules/ContentPreview/README.md) | Allows you to add a preview button. |
 | [`PublishLater`](../../modules/PublishLater/README.md) | Allows you to set a date in order to publish later. |
 | [`ReCaptcha`](../../modules/ReCaptcha/README.md) | Allows you to add a ReCaptcha. |
+| [`SeoMeta`](../../modules/Seo/README.md) | Allows you to configure SEO meta tags. |
+| [`AuditTrail`](../../modules/AuditTrail/README.md) | Allows you to add a comment describing the changes of a content item, to be recorded to the Audit Trail. |

src/docs/reference/modules/Contents/README.md

@@ -407,3 +407,9 @@ query {
   }
 }
 ```
+
+## Videos
+
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/j6xuupq9FYY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/wbTEUl_N0Lk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

src/docs/reference/modules/Cors/README.md

@@ -9,3 +9,7 @@ For more information, see https://docs.microsoft.com/en-us/aspnet/core/security/
 
 !!! warning
     As using AllowCredentials and AllowAnyOrigin at the same time is considered as a security risk, policies containing BOTH these options will NOT be activated.
+
+## Video
+
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/OYXFvKWyVGo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

src/docs/reference/modules/CustomSettings/README.md

@@ -62,4 +62,4 @@ public class MyController : Controller
 
 ## Video
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/RuDsBx4wdT0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/RuDsBx4wdT0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

src/docs/reference/modules/Deployment.Remote/README.md

@@ -0,0 +1,3 @@
+# Remote Deployment (`OrchardCore.Deployment.Remote`)
+
+Provides the ability to export and import to and from a remote server via [Deployment](../Deployment/README.md). This way, you can move content and configuration between remote Orchard Core sites.

src/docs/reference/modules/Deployment/README.md

@@ -0,0 +1,7 @@
+# Deployment (`OrchardCore.Deployment`)
+
+Provides features to move content and configuration between Orchard Core sites via [Recipes](../Recipes/README.md). Also see [Remote Deployment](../Deployment.Remote/README.md).
+
+## Video
+
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/wBWa28iHWHI" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

src/docs/reference/modules/Flow/README.md

@@ -27,3 +27,7 @@ And if you'd like to use the same template for Flow parts that have items and Fl
     }
   ]
 ```
+
+## Video
+
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/ufEhMXYZPy4" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

src/docs/reference/modules/Html/README.md

@@ -52,7 +52,7 @@ There are three predefined editor names:
 
 #### Video
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/lnjdRildsL8" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/lnjdRildsL8" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 
 ### Custom Editors
 

src/docs/reference/modules/Liquid/README.md

@@ -901,23 +901,23 @@ Using `helper` invokes the `validation_for` tag helper of ASP.NET Core with `spa
 
 ### `link`
 
-Invokes the `link` tag helper from the `Orchard.ResourceManagement` package. [see this section](../Resources/README.md#link-tag)
+Invokes the `link` tag helper from the `Orchard.ResourceManagement` package. [See this section.](../Resources/README.md#link-tag)
 
 ### `meta`
 
-Invokes the `meta` tag helper from the `Orchard.ResourceManagement` package. [see this section](../Resources/README.md#meta-tags)
+Invokes the `meta` tag helper from the `Orchard.ResourceManagement` package. [See this section.](../Resources/README.md#meta-tags)
 
 ### `resources`
 
-Invokes the `resources` tag helper from the `Orchard.ResourceManagement` package. [see this section](../Resources/README.md#rendering)
+Invokes the `resources` tag helper from the `Orchard.ResourceManagement` package. [See this section.](../Resources/README.md#rendering)
 
 ### `script`
 
-Invokes the `script` tag helper from the `Orchard.ResourceManagement` package. [see this section](../Resources/README.md#inline-definition)
+Invokes the `script` tag helper from the `Orchard.ResourceManagement` package. [See this section.](../Resources/README.md#inline-definition)
 
 ### `style`
 
-Invokes the `style` tag helper from the `Orchard.ResourceManagement` package. [see this section](../Resources/README.md#inline-definition)
+Invokes the `style` tag helper from the `Orchard.ResourceManagement` package. [See this section.](../Resources/README.md#inline-definition)
 
 ### `a`
 

src/docs/reference/modules/Lists/README.md

@@ -86,7 +86,7 @@ The `list_items` filter loads published content items for a given `ContentItem`
 
 ## Video
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/a3yyR27vdQQ" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/a3yyR27vdQQ" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 
 ## Lucene Indexing