Fix unrecognized relative links in the docs and GitHub Actions workflow to validate building the documentation (Lombiq Technologies: OCORE-155)

.github/workflows/docs_validation.yml

@@ -0,0 +1,36 @@
+name: Validating Building the Documentation
+
+on: 
+  push:
+    paths:
+      - 'mkdocs.yml'
+      - 'src/docs/**'
+    branches: [ main ]
+  pull_request:
+    paths:
+      - 'mkdocs.yml'
+      - 'src/docs/**'
+
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}-docs_validation
+  cancel-in-progress: true
+
+jobs:
+  validate-building-documentation:
+    name: Validating Building the Documentation
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        # Necessary to avoid mkdocs-git-revision-date-localized-plugin warnings.
+        fetch-depth: 0
+
+    - name: Install Dependencies
+      # Installing pip v22.0.3 is only necessary because unbuntu-latest runners include v22.0.2, which has a bug. That
+      # line can be removed once the runners are updated, see https://github.com/actions/runner-images?tab=readme-ov-file#available-images.
+      run: |
+        python -m pip install pip==22.0.3
+        pip install -r src/docs/requirements.txt -v
+
+    - name: Build Documentation
+      run: python -m mkdocs build --strict

src/docs/guides/create-modular-application-mvc/README.md

@@ -16,7 +16,7 @@ You will build a modular ASP.NET Core MVC web application similar to the sample
 
 There are different ways to create sites and modules for Orchard Core. You can learn more about them [here](../../getting-started/templates/README.md).
 
-In this guide we will use our [Code Generation Templates](../../getting-started/templates/). You can install the latest stable release of the templates using this command:
+In this guide we will use our [Code Generation Templates](../../getting-started/templates/README.md). You can install the latest stable release of the templates using this command:
 
 ```dotnet new install OrchardCore.ProjectTemplates::1.8.2-*```
 

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

@@ -415,9 +415,6 @@ When specifying a media profile with either the liquid, razor helper, or tag hel
     <img asset-src="Model.Paths[0]" img-profile="medium" img-resize-mode="Crop"/>
     ```
 
-!!! note
-    Media Profiles are only available from the [Preview Feed](../../../getting-started/preview-package-source)
-
 ## Media Text
 
 Media text is an optional setting, on by default, on the `MediaField`.
@@ -457,9 +454,6 @@ The `Anchors[]` is a less well known property of a `MediaField` and can be acces
 
 The `Anchors[]` is kept in sync with the `Paths[]` array and the index for a given path represents the index of a `Anchor` value.
 
-!!! note
-    Anchors are only available from the [Preview Feed](../../../getting-started/preview-package-source)
-
 ## Query string tokens
 
 When resizing images, the query string command values are, by default, signed with an HMAC signature that is unique to the tenant.
@@ -478,8 +472,7 @@ When the query string is signed with a token any width, height value may be used
 `<img src="/media/kittens.jpg?width=101&height=241&token=0J3hyv6jIPEsSdlvTCrf30fIdygkpmrF6mphqgYQyas%3D">`
 
 !!! note
-    Tokens are only available from the [Preview Feed](../../../getting-started/preview-package-source)
-    Prior to this the width or height values are limited to `16`, `32`, `50`, `100`, `160`, `240`, `480`, `600`, `1024`, `2048`.
+    Prior to tokens the width or height values are limited to `16`, `32`, `50`, `100`, `160`, `240`, `480`, `600`, `1024`, `2048`.
 
 ## Media Content Search
 

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

@@ -114,7 +114,7 @@ Here is a list of javascript methods provided by Orchard Modules.
 | Function | Description
 | -------- | ----------- |
 | `variables()` | Declare variables at the root of a recipe. Ex: `"variables": { "blogContentItemId": "[js:uuid()]" }`  Retrieve a variable value like this: `"ContentItemId": "[js: variables('blogContentItemId')]"` |
-| `parameters()` | Retrieves the parameters specified during the setup. Ex: `"Owner": "[js: parameters('AdminUserId')]"` See the available [Setup Recipe parameters](../Setup/#recipe-parameters) |
+| `parameters()` | Retrieves the parameters specified during the setup. Ex: `"Owner": "[js: parameters('AdminUserId')]"` See the available [Setup Recipe parameters](../Setup/README.md#recipe-parameters) |
 | `configuration(key: String, defaultValue: String)` | Retrieves the specified configuration setting by its key, optionally providing a default. Ex: `[js: configuration('OrchardCore_Admin:AdminUrlPrefix', 'Admin')]` See [IShellConfiguration](../../core/Configuration/README.md) |
 
 #### Workflows (`OrchardCore.Workflows.Http`)

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

@@ -20,10 +20,10 @@ Starting at version 1.7, the feature of creating a robots.txt file via site sett
 These default settings aim to provide a basic configuration that ensures search engines can access the necessary files and directories while restricting access to sensitive areas of the site. However, website owners can modify these settings according to their specific requirements by navigating to the admin dashboard then **Configuration** >> **Settings** >> **SEO**.
 
 !!! note
-    If the [Sitemaps](../Sitemaps) feature is enabled, all sitemap indexes and sitemaps are added to the `robots.txt` by default.
+    If the [Sitemaps](../Sitemaps/README.md) feature is enabled, all sitemap indexes and sitemaps are added to the `robots.txt` by default.
 
 !!! warning
-    If the site's [filesystem](../Tenants/#static-file-provider-feature) contains a `robots.txt`, this file will take precedence and the site settings to generate the files will be ignored.
+    If the site's [filesystem](../Tenants/README.md#static-file-provider-feature) contains a `robots.txt`, this file will take precedence and the site settings to generate the files will be ignored.
 
 ## Video
 

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

@@ -8,7 +8,7 @@ Shortcodes can be implemented by enabling the Shortcode Templates feature or thr
 
 ## Shortcode Templates
 
-Shortcode templates with [Liquid](../Liquid/) are created through the _Design -> Shortcodes_ menu.
+Shortcode templates with [Liquid](../Liquid/README.md) are created through the _Design -> Shortcodes_ menu.
 
 Shortcode templates are designed to be able to override a code based Shortcode of the same name.
 
@@ -120,11 +120,6 @@ services.AddShortcode<ImageShortcodeProvider>("image", describe => {
 });
 ```
 
-!!! note
-    When upgrading from version `1.0.0-rc2-13450` you may need to re-enable the Shortcodes feature, through _Configuration -> Features_
-
-    The Shortcode Templates feature is only available from the [Preview Feed](../../../getting-started/preview-package-source)
-
 ## Available Shortcodes
 
 ### `[image]`

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

@@ -488,7 +488,7 @@ This template is called when a content field shape type is rendered for a given
 The differentiator uniquely identifies a shape in a zone. When rendering a content item, the shape has a `Content` property that contains
 all the shapes provided by content display drivers, including the ones for content parts and content fields.
 
-Differentiators can be used to configure the placement information (c.f. [Placement documentation page](../../core/Placement/)), or to access specific shapes in a zone using these template helpers:
+Differentiators can be used to configure the placement information (c.f. [Placement documentation page](../../core/Placement/README.md)), or to access specific shapes in a zone using these template helpers:
 
 ### Content Part differentiator
 

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

@@ -155,7 +155,7 @@ The following JavaScript functions are available by default to any activity that
 | `output` | Sets an output parameter with the specified name. Workflow output can be collected by the invoker of the workflow. | `output(name: string, value: any): void` |
 | `property` | Returns the property value with the specified name. Properties are a dictionary that workflow activities can read and write information from and to. | `property(name: string): any` |
 | `setProperty` | Stores the specified data in workflow properties. | `setProperty(name: string,data:any):void` |
-| `executeQuery` | Returns the result of the query, see [more](../Queries/#scripting). | `executeQuery(name: String, parameters: Dictionary<string,object>): IEnumerable<object>` |
+| `executeQuery` | Returns the result of the query, see [more](../Queries/README.md#scripting). | `executeQuery(name: String, parameters: Dictionary<string,object>): IEnumerable<object>` |
 | `log` | Output logs according to the specified log level. Allowed log levels : `'Trace','Debug','Information','Warning','Error','Critical','None'` | `log(level: string, text: string, param: object): void` |
 | `lastResult` | Returns the value that the previous activity provided, if any. | `lastResult(): any` |
 | `correlationId` | Returns the correlation value of the workflow instance. | `correlationId(): string` |

src/docs/releases/1.7.0.md

@@ -148,7 +148,7 @@ With the newly added options, we can now allow searching for user based on eithe
 The `Seo` feature now provides `robots.txt` out of the box when the filesystem does not contain one. New settings are available at **Configuration** >> **Settings** >> **SEO** to allow you to configure what should be included into the `robots.txt` file.
 
 !!! note
-    If the [Sitemaps](../modules/Sitemaps) feature is enabled, all sitemap indexes and sitemaps are added to the `robots.txt` by default.
+    If the [Sitemaps](../reference/modules/Sitemaps/README.md) feature is enabled, all sitemap indexes and sitemaps are added to the `robots.txt` by default.
 
 ### `OrchardCore.Contents` Module
 

src/docs/resources/README.md

@@ -4,13 +4,13 @@ Many external resources are available in order to teach you how to develop with
 
 ## Overview
 
-- [Tutorials](tutorials): List of tutorials to discover Orchard Core.
-- [Development Tools](development-tools): List of tools that help you developing with Orchard Core.
-- [Meeting](meeting): Join us for our weekly meetings each Tuesdays and Thursdays.
-- [Branding](branding): Get some official assets and share about the project philosophy.
-- [Libraries](libraries): List of external libraries and licenses used in Orchard Core.
-- [Owners](owners): List of the main contributors and their contribution areas.
-- [Workshops](workshops): Training sessions developed by our contributors.
+- [Tutorials](tutorials/README.md): List of tutorials to discover Orchard Core.
+- [Development Tools](development-tools/README.md): List of tools that help you developing with Orchard Core.
+- [Meeting](meeting/README.md): Join us for our weekly meetings each Tuesdays and Thursdays.
+- [Branding](branding/README.md): Get some official assets and share about the project philosophy.
+- [Libraries](libraries/README.md): List of external libraries and licenses used in Orchard Core.
+- [Owners](owners/README.md): List of the main contributors and their contribution areas.
+- [Workshops](workshops/README.md): Training sessions developed by our contributors.
 
 ## Newsletter
 

src/docs/resources/meeting/README.md

@@ -3,7 +3,7 @@
 Every week, we organize 2 meetings on <http://orchardcore.net/meeting>.  
 You can join by using the online webclient or install Microsoft Teams.
 
-## Steering commitee meeting
+## Steering committee meeting
 
 On Tuesday at [12:00 PST](https://www.google.com/search?q=12%3A00+pst).  
 During this meeting we discuss about:

src/docs/topics/configuration/README.md

@@ -1,6 +1,6 @@
 # Configuration
 
-Orchard Core allows you to create your own setup templates (know as [Recipes](../glossary/#Recipe)) and configure your [Tenants](../glossary/#Tenant) individually.
+Orchard Core allows you to create your own setup templates (know as [Recipes](../../glossary/README.md#Recipe)) and configure your [Tenants](../../glossary/README.md#Tenant) individually.
 
 ## Configure your Orchard Core instance
 

src/docs/topics/security/README.md

@@ -6,7 +6,7 @@ Orchard Core provides many security features to give an authenticated access to
 
 - [Microsoft Authentication](../../reference/modules/Microsoft.Authentication/README.md)
 - [Facebook Authentication](../../reference/modules/Facebook/README.md)
-- [Twitter Authentication](../../reference/modules/Twitter/README.md)
+- [Twitter Authentication](../../reference/modules/X/README.md)
 - [GitHub Authentication](../../reference/modules/GitHub/README.md)
 - [Google Authentication](../../reference/modules/Google/README.md)
 - [OpenId](../../reference/modules/OpenId/README.md)