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

More automatic documentation build checks (Lombiq Technologies: OCORE-164) #15887

Merged
merged 6 commits into from
Apr 28, 2024
Merged
Show file tree
Hide file tree
Changes from 5 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
3 changes: 1 addition & 2 deletions OrchardCore.sln
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,6 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{E33D95DF-E864-4D14-A561-D59E8AC06811}"
ProjectSection(SolutionItems) = preProject
mkdocs.yml = mkdocs.yml
src\README.md = src\README.md
EndProjectSection
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Docs", "src\docs\OrchardCore.Docs.csproj", "{A37CD7CB-6B26-483A-9D5A-3E80B6CB115F}"
Expand Down Expand Up @@ -500,7 +499,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Notifications.C
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Notifications", "src\OrchardCore.Modules\OrchardCore.Notifications\OrchardCore.Notifications.csproj", "{19594A96-A033-4820-820B-C6186D00D507}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OrchardCore.HealthChecks.Abstractions", "src\OrchardCore\OrchardCore.HealthChecks.Abstractions\OrchardCore.HealthChecks.Abstractions.csproj", "{91CED599-45B1-474D-A7F2-231BF857A5F2}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.HealthChecks.Abstractions", "src\OrchardCore\OrchardCore.HealthChecks.Abstractions\OrchardCore.HealthChecks.Abstractions.csproj", "{91CED599-45B1-474D-A7F2-231BF857A5F2}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Seo.Abstractions", "src\OrchardCore\OrchardCore.Seo.Abstractions\OrchardCore.Seo.Abstractions.csproj", "{C61CC748-39BD-4900-9FEE-A2483259573D}"
EndProject
Expand Down
371 changes: 190 additions & 181 deletions mkdocs.yml

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions src/README.md → src/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Orchard Core CMS is a complete rewrite of Orchard CMS on ASP.NET Core. It’s no


!!! tip
Check out [the Reference of Built-in Modules](docs/reference/README.md) to see what kind of features Orchard Core provides built-in.
Check out [the Reference of Built-in Modules](reference/README.md) to see what kind of features Orchard Core provides built-in.

## Different website building strategies

Expand All @@ -58,11 +58,11 @@ Orchard Core CMS supports all major site building strategies:

## Status

The latest released version of Orchard Core is `1.8.3`. The release notes can be found under [Releases](docs/releases/1.8.3.md).
The latest released version of Orchard Core is `1.8.3`. The release notes can be found under [Releases](releases/1.8.3.md).

## Getting Started

- See [our getting started guide](docs/getting-started/README.md) or [test drive Orchard Core](docs/getting-started/test-drive-orchard-core.md).
- See [our getting started guide](getting-started/README.md) or [test drive Orchard Core](getting-started/test-drive-orchard-core.md).
- Watch the [ASP.NET Community Standup video where Orchard Core was demonstrated](https://www.youtube.com/watch?v=HeDjv3blBjQ&t=2246s&list=PL1rZQsJPBU2StolNg0aqvQswETPcYnNKL&index=24).
- Follow the samples on <https://github.com/OrchardCMS/OrchardCore.Samples> that will guide you on how to build **modular** and **multi-tenant** applications
- Follow the tutorial inside the [Training Demo Module](https://github.com/Lombiq/Orchard-Training-Demo-Module) to learn how to develop Orchard Core modules.
Expand Down
2 changes: 2 additions & 0 deletions src/docs/community/contributors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
!!! tip
Piedone marked this conversation as resolved.
Show resolved Hide resolved
You can add new contributors by [using the All Contributors bot](https://allcontributors.org/docs/en/bot/usage).

<!-- This is for the auto-generated All Contributors badge to point somewhere. -->
MikeAlhayek marked this conversation as resolved.
Show resolved Hide resolved
<a id="contributors-"></a>
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
Expand Down
2 changes: 1 addition & 1 deletion src/docs/guides/contributing/contributing-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ With MkDocs you can get the full docs.orchardcore.net experience locally too. If
1. Follow the [MkDocs installation guide](https://www.mkdocs.org/user-guide/installation/) to install Python, PIP and MkDocs. If you already have a fresh enough Python installation, you can simply run `pip install mkdocs`.
2. Open a command line in the root of your clone of the repository.
3. Run `pip install -r src/docs/requirements.txt` to install dependencies.
4. Run `python -m mkdocs serve` to start the site. You'll then be able to browse it under <http://127.0.0.1:8000>. If you use Visual Studio under Windows, we recommend NOT running the command from a Windows PowerShell prompt opened from Visual Studio's Solution Explorer. Instead, open CMD or a PowerShell 7+ window; for some reason, the MkDocs build is really slow under Windows PowerShell.
4. Run `python -m mkdocs serve` to start the site. You'll then be able to browse it under <http://127.0.0.1:8000>.

## Submitting a pull request and gathering feedback

Expand Down
2 changes: 1 addition & 1 deletion src/docs/reference/core/Modules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Next, within `Startup.cs`, modify the method `ConfigureServices` to look like th

Asp.Net Mvc is now part of your pipeline.

You can find a sample application here: [`OrchardCore.Mvc.Web`](../../../../OrchardCore.Mvc.Web/Program.cs)
You can find a sample application here: [`OrchardCore.Mvc.Web`](https://github.com/OrchardCMS/OrchardCore/blob/main/src/OrchardCore.Mvc.Web/Program.cs)

## Configuration

Expand Down
2 changes: 1 addition & 1 deletion src/docs/reference/modules/Contents/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ The available options depend on the scalar and part fields defined on the type i
##### Single Filters

If you supply exactly one parameter to the `where` argument, the query response will only contain content items that adhere to this constraint.
Multiple filters can be combined using `AND` and/or `OR`, see [below](#arbitrary-combination-of-filters-with-and-and-or) for more details.
Multiple filters can be combined using `AND` and/or `OR`, see [below](#arbitrary-combination-of-filters-with-and-or-and-not) for more details.

##### Filtering by a publication status

Expand Down
2 changes: 1 addition & 1 deletion src/docs/reference/modules/Resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,7 @@ The style block will only be injected once based on its name and can optionally

#### Link tag

A link tag is used to define the relationship between the current document and an external resource such as a favicon or stylesheet. For a stylesheet, however, use the [style helper](#register-a-named-script).
A link tag is used to define the relationship between the current document and an external resource such as a favicon or stylesheet. For a stylesheet, however, use the [style helper](#register-a-named-script-or-stylesheet).

=== "Liquid"

Expand Down
6 changes: 3 additions & 3 deletions src/docs/reference/modules/Themes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,14 +100,14 @@ The __Bag__ part will invoke all available display drivers recursively, to rende

Each of these drivers return one or more shapes that are added to named zones (or sections) of a global __Shape__ called the `Content` shape.

For instance the `TitleDisplayDriver` class will return a shape of type `TitlePart` in the `Header` zone of the main shape at position `5`. See [TitlePartDisplayDriver](../../../../OrchardCore.Modules/OrchardCore.Title/Drivers/TitlePartDisplayDriver.cs#L14-L20)
For instance the `TitleDisplayDriver` class will return a shape of type `TitlePart` in the `Header` zone of the main shape at position `5`. See [`TitlePartDisplayDriver`](https://github.com/OrchardCMS/OrchardCore/blob/main/src/OrchardCore.Modules/OrchardCore.Title/Drivers/TitlePartDisplayDriver.cs)

Then the `BagPart` shape is added in the `Content` zone of the main shape at the position `5`. See [BagPartDisplayDriver](../../../../OrchardCore.Modules/OrchardCore.Flows/Drivers/BagPartDisplayDriver.cs#L39-L45).
Then the `BagPart` shape is added in the `Content` zone of the main shape at the position `5`. See [`BagPartDisplayDriver`](https://github.com/OrchardCMS/OrchardCore/blob/main/src/OrchardCore.Modules/OrchardCore.Flows/Drivers/BagPartDisplayDriver.cs).

Once all the drivers for all the parts and all the fields have returned their shapes to specific zones of the main `Content` shape, Orchard will look for a matching template.
Template matching is done dynamically, and if no specific ones are created for a Content Type, then the file `Content.cshtml` (or `Content.liquid`) is used.
The default template will go over all the zones it knows about and render the shapes that are inside each of them.
See [Header](../../../../OrchardCore.Modules/OrchardCore.Contents/Views/Content.cshtml#L17) where the `Header` zone shapes are rendered (the `TitlePart` shape) and also [Content](../../../../OrchardCore.Modules/OrchardCore.Contents/Views/Content.cshtml#L24) where the `Content` zone shapes are rendered (`BagPart` and `TextField` shapes).
See [the source file](https://github.com/OrchardCMS/OrchardCore/blob/main/src/OrchardCore.Modules/OrchardCore.Contents/Views/Content.cshtml) where the `Header` zone shapes are rendered (the `TitlePart` shape) and also `Content` where the `Content` zone shapes are rendered (`BagPart` and `TextField` shapes).

## Customizing templates

Expand Down
2 changes: 1 addition & 1 deletion src/docs/topics/configuration/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Configuration

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.
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.
Piedone marked this conversation as resolved.
Show resolved Hide resolved

## Configure your Orchard Core instance

Expand Down
2 changes: 1 addition & 1 deletion src/docs/topics/display/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Display

Orchard Core allows you to customize the look and feel of your application by integrating your own [theme](../../glossary/README.md#Theme) or by overriding the rendering of the [templates](../../glossary/README.md#Template) in Razor or Liquid syntax.
Orchard Core allows you to customize the look and feel of your application by integrating your own [theme](../../glossary/README.md#theme) or by overriding the rendering of the [templates](../../glossary/README.md#template) in Razor or Liquid syntax.

## Customize your Display

Expand Down
2 changes: 1 addition & 1 deletion src/docs/topics/search/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Search

Orchard Core allows you to define the information to [index](../../glossary/README.md#Indexing) and to [query](../../glossary/README.md#Query) them in order to provide an integrated Search experience.
Orchard Core allows you to define the information to [index](../../glossary/README.md#indexing) and to [query](../../glossary/README.md#query) them in order to provide an integrated Search experience.
Piedone marked this conversation as resolved.
Show resolved Hide resolved

## Query and Search

Expand Down