Skip to content

Commit

Permalink
Fix table format in docs (#17446)
Browse files Browse the repository at this point in the history
  • Loading branch information
@hishamco
hishamco authored Feb 4, 2025
1 parent 0d33478 commit 90411df
Show file tree
Hide file tree
Showing 50 changed files with 1,411 additions and 1,411 deletions.
40 changes: 20 additions & 20 deletions src/docs/community/owners/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

The below table lists the different code/features areas and their owners:

| Owner | Area |
|--- | --- |
| [Jean-Thierry Kéchichian](https://github.com/jtkech) | Infrastructure, Build, Distributed Services |
| [Sipke Schoorstra](https://github.com/sfmskywalker) | Forms, Workflows |
| [Nicholas Mayne](https://github.com/Jetski5822) | GraphQL |
| [Carl Woodhouse](https://github.com/carlwoodhouse) | GraphQL |
| [Kévin Chalet](https://github.com/kevinchalet) | OpenID |
| [Dean Marcussen](https://github.com/deanmarcussen) | Azure, Media, Shortcodes, Sitemaps, Taxonomies |
| [Antoine Griffard](https://github.com/agriffard) | Docs, Crowdin Translations, Try, Website |
| [Hisham Bin Ateya](https://github.com/hishamco) | Cultures, Email, Localization, RTL, Translation, UI |
| [Jean-Philippe Tissot](https://github.com/jptissot) | Localization, Tests |
| [Larrem Panganiban](https://github.com/larremp) | Workshops |
| [Lukas Kabrt](https://github.com/lukaskabrt) | Po files extractor |
| [Matias Molleja](https://github.com/matiasmolleja) | Media |
| [Michael Petrinolis](https://github.com/MichaelPetrinolis) | External authentication providers |
| [Zoltán Lehóczky](https://github.com/Piedone) | PublishLater, Preview packages |
| [Sébastien Ros](https://github.com/sebastienros) | YesSql, Fluid, Jint, Shortcodes |
| [Jasmin Savard](https://github.com/skrypt) | Lucene, Indexing, Admin, UI |
| [Bertrand Le Roy](https://github.com/bleroy) | Commerce module |
| [Mike Alhayek](https://github.com/MikeAlhayek) | Azure AI Search, Notifications, SMS |
| Owner | Area |
|------------------------------------------------------------|-----------------------------------------------------|
| [Jean-Thierry Kéchichian](https://github.com/jtkech) | Infrastructure, Build, Distributed Services |
| [Sipke Schoorstra](https://github.com/sfmskywalker) | Forms, Workflows |
| [Nicholas Mayne](https://github.com/Jetski5822) | GraphQL |
| [Carl Woodhouse](https://github.com/carlwoodhouse) | GraphQL |
| [Kévin Chalet](https://github.com/kevinchalet) | OpenID |
| [Dean Marcussen](https://github.com/deanmarcussen) | Azure, Media, Shortcodes, Sitemaps, Taxonomies |
| [Antoine Griffard](https://github.com/agriffard) | Docs, Crowdin Translations, Try, Website |
| [Hisham Bin Ateya](https://github.com/hishamco) | Cultures, Email, Localization, RTL, Translation, UI |
| [Jean-Philippe Tissot](https://github.com/jptissot) | Localization, Tests |
| [Larrem Panganiban](https://github.com/larremp) | Workshops |
| [Lukas Kabrt](https://github.com/lukaskabrt) | Po files extractor |
| [Matias Molleja](https://github.com/matiasmolleja) | Media |
| [Michael Petrinolis](https://github.com/MichaelPetrinolis) | External authentication providers |
| [Zoltán Lehóczky](https://github.com/Piedone) | PublishLater, Preview packages |
| [Sébastien Ros](https://github.com/sebastienros) | YesSql, Fluid, Jint, Shortcodes |
| [Jasmin Savard](https://github.com/skrypt) | Lucene, Indexing, Admin, UI |
| [Bertrand Le Roy](https://github.com/bleroy) | Commerce module |
| [Mike Alhayek](https://github.com/MikeAlhayek) | Azure AI Search, Notifications, SMS |
46 changes: 23 additions & 23 deletions src/docs/guides/leverage-csproj-meta-info/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,22 +70,22 @@ There are several items you may be interested in, depending on your projects, i.

With all _properties_ described as follows.

|Property|Type|Description|
|-|-|-|
|`Include`|`string` <sup>1</sup>|Required, signals `MSBuild` that an _item list_ is supported, which `Identity` serves as the attribute `Id`.|
|`Name`|`string`|Optional, human readable name for the module or feature.|
|`Base`|`string`|Optional, the base theme from which the assembly is derived. Not applicable to either _features_ or _modules_.|
|`ModuleType`|`string`|Optional author provided `Type`; defaults to `"Module"` or `"Theme"`. Not applicable to _features_ since this is a _Module_ base class property. <sup>2</sup>|
|`Category`|`string`|Optional category for the feature.|
|`Priority`|`int` <sup>1</sup>|Optional integer priority, given as a `string`, defaults to `0`; lower priority given precedence.|
|`Description`|`string`|Optional descriptive text.|
|`Author`|`string`|Optional, author provided identification.|
|`Version`|`string`|Optional, recommended, semantic versioning text, defaults to `"0.0"`.|
|`Dependencies`|`list`|Optional, semi-colon delimited list of _Module Identifier_ dependencies. <sup>3</sup>|
|`Tags`|`list`|Optional, semi-colon delimited list of tags. <sup>3</sup>|
|`DefaultTenant`|`bool` <sup>1</sup>|Optional, Boolean, `true|false`, defaults to`false`.|
|`AlwaysEnabled`|`bool` <sup>1</sup>|Optional, Boolean, `true|false`, defaults to`false`.|
|`EnabledByDependencyOnly`|`bool` <sup>1</sup>|Optional, Boolean, `true|false`, defaults to`false`.|
| Property | Type | Description |
|---------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `Include` | `string` <sup>1</sup> | Required, signals `MSBuild` that an _item list_ is supported, which `Identity` serves as the attribute `Id`. |
| `Name` | `string` | Optional, human readable name for the module or feature. |
| `Base` | `string` | Optional, the base theme from which the assembly is derived. Not applicable to either _features_ or _modules_. |
| `ModuleType` | `string` | Optional author provided `Type`; defaults to `"Module"` or `"Theme"`. Not applicable to _features_ since this is a _Module_ base class property. <sup>2</sup> |
| `Category` | `string` | Optional category for the feature. |
| `Priority` | `int` <sup>1</sup> | Optional integer priority, given as a `string`, defaults to `0`; lower priority given precedence. |
| `Description` | `string` | Optional descriptive text. |
| `Author` | `string` | Optional, author provided identification. |
| `Version` | `string` | Optional, recommended, semantic versioning text, defaults to `"0.0"`. |
| `Dependencies` | `list` | Optional, semi-colon delimited list of _Module Identifier_ dependencies. <sup>3</sup> |
| `Tags` | `list` | Optional, semi-colon delimited list of tags. <sup>3</sup> |
| `DefaultTenant` | `bool` <sup>1</sup> | Optional, Boolean, `true |false`, defaults to`false`.|
| `AlwaysEnabled` | `bool` <sup>1</sup> | Optional, Boolean, `true |false`, defaults to`false`.|
| `EnabledByDependencyOnly` | `bool` <sup>1</sup> | Optional, Boolean, `true |false`, defaults to`false`.|

<sup>[1] `MSBuild` relays all meta data as `string`, leaving authors to contend with either `string` or `object` type conversions i.e. either `int` or `bool`, which is fine for our purposes.</sup>
<br/><sup>[2] Depending on the `Attribute` context, `ModuleAttribute` yields `"Module"`, `ThemeAttribute` yields `"Theme"` by default.</sup>
Expand All @@ -99,20 +99,20 @@ And for convenience, you may specify all of your assembly Orchard Core attribute
... />
```

|Property|Type|Description|
|-|-|-|
|`Type`|`string`|Commonly either, `"feature"`, `"theme"` or `"module"`. Anything else not `"feature"` or `"theme"` assumes _Module_.|
| Property | Type | Description |
|----------|----------|---------------------------------------------------------------------------------------------------------------------|
| `Type` | `string` | Commonly either, `"feature"`, `"theme"` or `"module"`. Anything else not `"feature"` or `"theme"` assumes _Module_. |

Otherwise, the `OrchardCoreAttributes` should include all the same _properties_ that the desired `Type` would require.

## Targets order dependencies

A couple of convenience [`MSBuild` _properties_](https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild-properties) are provided, which authors may leverage in order to accommodate their internal target build orders.

|Property|Default|Description|
|-|-|-|
|`OrchardCoreEmbeddingAfterTargets`|`AfterResolveReferences`|_Orchard Core_ assembly embedding to occur **_after_** these targets.|
|`OrchardCoreEmbeddingBeforeTargets`|`GenerateAssemblyInfo`|_Orchard Core_ assembly embedding to occur **_before_** these targets.|
| Property | Default | Description |
|-------------------------------------|--------------------------|------------------------------------------------------------------------|
| `OrchardCoreEmbeddingAfterTargets` | `AfterResolveReferences` | _Orchard Core_ assembly embedding to occur **_after_** these targets. |
| `OrchardCoreEmbeddingBeforeTargets` | `GenerateAssemblyInfo` | _Orchard Core_ assembly embedding to occur **_before_** these targets. |

We do not recommend changing the defaults in any way, but rather to append with your custom targets as desired, i.e.

Expand Down
Loading

0 comments on commit 90411df

Please sign in to comment.