Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 20 commits into from
Feb 14, 2022
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -184,6 +185,7 @@ nav:
- 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
Expand All @@ -201,6 +203,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
Expand Down
16 changes: 8 additions & 8 deletions src/OrchardCore.Build/OrchardCore.Commons.props
Original file line number Diff line number Diff line change
Expand Up @@ -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>
4 changes: 4 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
hishamco marked this conversation as resolved.
Show resolved Hide resolved
11 changes: 7 additions & 4 deletions src/docs/getting-started/starter-recipes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
4 changes: 4 additions & 0 deletions src/docs/guides/decoupled-cms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
4 changes: 4 additions & 0 deletions src/docs/reference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,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)
hishamco marked this conversation as resolved.
Show resolved Hide resolved
- [Content Fields](modules/ContentFields/README.md)
- [Content Preview](modules/ContentPreview/README.md)
- [Taxonomies](modules/Taxonomies/README.md)
Expand Down Expand Up @@ -109,6 +110,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

Expand Down
2 changes: 1 addition & 1 deletion src/docs/reference/core/Placement/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
6 changes: 3 additions & 3 deletions src/docs/reference/modules/AdminDashboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
4 changes: 2 additions & 2 deletions src/docs/reference/modules/ContentFields/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions src/docs/reference/modules/ContentParts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ 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. |
6 changes: 6 additions & 0 deletions src/docs/reference/modules/Contents/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -407,3 +407,9 @@ query {
}
}
```

## Video
hishamco marked this conversation as resolved.
Show resolved Hide resolved

<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>
4 changes: 4 additions & 0 deletions src/docs/reference/modules/Cors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
2 changes: 1 addition & 1 deletion src/docs/reference/modules/CustomSettings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
3 changes: 3 additions & 0 deletions src/docs/reference/modules/Deployment.Remote/README.md
Original file line number Diff line number Diff line change
@@ -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.
hishamco marked this conversation as resolved.
Show resolved Hide resolved
7 changes: 7 additions & 0 deletions src/docs/reference/modules/Deployment/README.md
Original file line number Diff line number Diff line change
@@ -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>
4 changes: 4 additions & 0 deletions src/docs/reference/modules/Flow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
2 changes: 1 addition & 1 deletion src/docs/reference/modules/Html/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 5 additions & 5 deletions src/docs/reference/modules/Liquid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion src/docs/reference/modules/Lists/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 5 additions & 1 deletion src/docs/reference/modules/Lucene/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,4 +133,8 @@ So you can use :
`geo_bounding_box`

See ElasticSearch documentation for more details :
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html

## Video

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/9EgZ_J1npw4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
6 changes: 4 additions & 2 deletions src/docs/reference/modules/Media/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -497,12 +497,14 @@ To set up indexing for Media do the following:

## Videos

<iframe width="560" height="315" src="https://www.youtube.com/embed/BQHUlvPFRR4" 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/BQHUlvPFRR4" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

<iframe width="560" height="315" src="https://www.youtube.com/embed/K0_i4vj00yM" 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/K0_i4vj00yM" 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/bDxL2LPJPzk" 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/Nb5GUqM7ZzI" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

## Credits

To index PDF files the [PdfPig library](https://github.com/UglyToad/PdfPig/) is used.
Expand Down
4 changes: 4 additions & 0 deletions src/docs/reference/modules/Menu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,3 +246,7 @@ function activateLinks(options,cb)

<https://github.com/ilikenwf/nestedSortable>
License: MIT

## Video

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/mOhbqHKd_CI" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
2 changes: 1 addition & 1 deletion src/docs/reference/modules/PublishLater/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Adds the ability to schedule content items to be published at a given future dat

## Video

<iframe width="560" height="315" src="https://www.youtube.com/embed/E7UH8R14EUA" 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/E7UH8R14EUA" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
10 changes: 9 additions & 1 deletion src/docs/reference/modules/Recipes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ The WorkflowType step allows you to create a Workflow.

### Deployment Step

The Deployment step allows you to create a deployment plan with deployment steps.
The Deployment step allows you to create a deployment plan with deployment steps. Also see [Deployment](../Deployment/README.md).

```json
{
Expand Down Expand Up @@ -500,3 +500,11 @@ And here are the migration recipes referenced in the code above:
]
}
```

## Videos
hishamco marked this conversation as resolved.
Show resolved Hide resolved

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/uJobH9izfLI" 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/qPCBgHQYz1g" 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/A13Li0CblK8" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
13 changes: 13 additions & 0 deletions src/docs/reference/modules/Redis/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Redis (`OrchardCore.Redis`)

Integrates Redis into Orchard Core. Provides the following features:

- Redis: Redis configuration support.
- Redis Cache: Distributed cache using Redis.
- Redis Bus: Makes the Signal service distributed.
hishamco marked this conversation as resolved.
Show resolved Hide resolved
- Redis Lock: Distributed Lock using Redis.
- Redis DataProtection: Distributed DataProtection using Redis.

## Video

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/etH6IJOGUe8" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Loading