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

I made a start on vale prose fixes #83

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public string Alias { get; }

#### AllowedAttributes

Gets the list of allowed Product Attribtues for this Product Attribute Preset
Gets the list of allowed Product Attributes for this Product Attribute Preset

```csharp
public IReadOnlyCollection<AllowedProductAttribute> AllowedAttributes { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public ProductVariantCollection(Guid storeId, IList<ProductVariantItem> list)

| Parameter | Description |
| --- | --- |
| storeId | The StoreId the product variants belogn to |
| storeId | The StoreId the product variants belong to |
| list | The list to wrap. |


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: API reference for Vendr.Web.PropertyEditors in Vendr, the eCommerce

| Public Type | Description |
| --- | --- |
| class [VariantsEditorComponent](variantseditorcomponent/) | Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSycn too. We could also look to potetially use this in the value converter for the variants editor as we now have this also being store aware. |
| class [VariantsEditorComponent](variantseditorcomponent/) | Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSync too. We could also look to potentially use this in the value converter for the variants editor as we now have this also being store aware. |
| class [VariantsEditorComposer](variantseditorcomposer/) | |
| class [VariantsEditorConfiguration](variantseditorconfiguration/) | |
| class [VariantsEditorDataConverter](variantseditordataconverter/) | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: API reference for VariantsEditorComponent in Vendr, the eCommerce s
---
## VariantsEditorComponent

Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSycn too. We could also look to potetially use this in the value converter for the variants editor as we now have this also being store aware.
Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSync too. We could also look to potentially use this in the value converter for the variants editor as we now have this also being store aware.

```csharp
public class VariantsEditorComponent : IComponent
Expand Down
6 changes: 3 additions & 3 deletions content/core/1.7.0/key-concepts/search-specifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ var results = _orderService.SearchOrders(
.And(where.HasOrderNumber(orderNumber).Or(where.ByCustomer(customerEmail))))
````

The above is relatively simple example but it demonstrates the use of a delegate method that then uses a fluent specifications API to build up a query filter. The query filter itself can be made up of many different individual queries which themselves can be grouped using AND and OR query logic.
The above is a relatively simple example, but it demonstrates the use of a delegate method that then uses a fluent specifications API to build up a query filter. The query filter itself can be made up of many different individual queries, which themselves can be grouped using AND and OR query logic.

Because the API is fluent it is also self documenting, with Visual Studio intellisense able to guide developers through all the available specifications.
Because the API is fluent, it is also self-documenting, with Visual Studio Intellisense able to guide developers through all the available specifications.

## Ordering Results

Expand All @@ -42,4 +42,4 @@ var results = _orderService.SearchOrders(
(orderBy) => orderBy
.FinalizedDate(Sort.Descending)
.Then(orderBy.CreateDate(Sort.Descending)))
````
````
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public interface IVendrSettings

#### BackOfficeMvcArea

Gets the back office MVC area under which Vendr is installed
Gets the backoffice MVC area under which Vendr is installed

```csharp
public string BackOfficeMvcArea { get; }
Expand All @@ -28,7 +28,7 @@ public string BackOfficeMvcArea { get; }

#### BackOfficePath

Gets the back office path for this Vendr install
Gets the backoffice path for this Vendr install

```csharp
public string BackOfficePath { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public string Alias { get; }

#### AllowedAttributes

Gets the list of allowed Product Attribtues for this Product Attribute Preset
Gets the list of allowed Product Attributes for this Product Attribute Preset

```csharp
public IReadOnlyCollection<AllowedProductAttribute> AllowedAttributes { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public ProductVariantCollection(Guid storeId, IList<ProductVariantItem> list)

| Parameter | Description |
| --- | --- |
| storeId | The StoreId the product variants belogn to |
| storeId | The StoreId the product variants belong to |
| list | The list to wrap. |


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ public PagedResult<OrderReadOnly> SearchOrders(IQuerySpecification<OrderReadOnly
| Parameter | Description |
| --- | --- |
| query | The query specification to perform |
| sort | The sort order specification describinng the sort order in which to return the results |
| sort | The sort order specification describing the sort order in which to return the results |
| currentPage | The page of results of which to retrieve |
| itemsPerPage | The number of items per page to return |

Expand Down Expand Up @@ -344,7 +344,7 @@ public PagedResult<OrderReadOnly> SearchOrders(
| Parameter | Description |
| --- | --- |
| query | The factory method to generate the query specification to perform |
| sort | The factory method to generate the sort order specification describinng the sort order in which to return the results |
| sort | The factory method to generate the sort order specification describing the sort order in which to return the results |
| currentPage | The page of results of which to retrieve |
| itemsPerPage | The number of items per page to return |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: API reference for Vendr.Web.PropertyEditors in Vendr, the eCommerce

| Public Type | Description |
| --- | --- |
| class [VariantsEditorComponent](variantseditorcomponent/) | Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSycn too. We could also look to potetially use this in the value converter for the variants editor as we now have this also being store aware. |
| class [VariantsEditorComponent](variantseditorcomponent/) | Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSync too. We could also look to potentially use this in the value converter for the variants editor as we now have this also being store aware. |
| class [VariantsEditorComposer](variantseditorcomposer/) | |
| class [VariantsEditorConfiguration](variantseditorconfiguration/) | |
| class [VariantsEditorDataConverter](variantseditordataconverter/) | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: API reference for VariantsEditorComponent in Vendr, the eCommerce s
---
## VariantsEditorComponent

Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSycn too. We could also look to potetially use this in the value converter for the variants editor as we now have this also being store aware.
Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSync too. We could also look to potentially use this in the value converter for the variants editor as we now have this also being store aware.

```csharp
public class VariantsEditorComponent : IComponent
Expand Down
6 changes: 3 additions & 3 deletions content/core/1.8.0/key-concepts/bulk-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,15 @@ Once created, the bulk action will then be displayed in the bulk actions bar for
| `getConfirmMessage(total)` | A function that can provider a message to display before a bulk action is triggered should confirmation be required for the action to run. Returns an Promise that returns a string. |
| `getStatusMessage(count, total)` | A function used to provider a status message after each item has been processed. Displayed in the bulk actions bar after each `itemAction` has been called. Returns an Promise that returns a string. |
| `getSuccessMessage(total)` | A function to return a success message after all bulk actions have been performed. Returns an Promise that returns a string. |
| `condition(context)` | As all bulk actions are registered globally for all entity types, the `condition` function can be used to filer when, and for which entities a bulk action will actually display. |
| `condition(context)` | As all bulk actions are registered globally for all entity types, the `condition` function can be used to filter when, and for which entities a bulk action will display. |

† Only a `itemAction` OR a `bulkAction` method should be defined for a bulk action configuration. If both are present, the `bulkAction` will be used and the `itemAction` will be ignored. If processing of items can be done individually, it is better to use the `itemAction` in order to provider user feedback. `bulkAction` should only be used where items need to be processed in a single action.

## Important Notes

* Most methods apart from `itemAction` or `bulkAction` are optional. If methods aren't present, a default implementation will be used, or, where those methods trigger specific functionality such as the `configure` or `getConfirmMessage` methods, that functionality will become disabled.
* It's important to note the array based syntax for registering a bulk action with angular dependencies. Each bulk action is registered as an array, where all dependencies are defined first and then a factory function is defined last which returns the actual bulk action definition.
* Whilst these docs outline how to define a bulk action, you will likely need to register further resources / services that can actually perform the given bulk operation and include these as a dependency for your action.
* Whilst these docs outline how to define a bulk action, you will likely need to register further resources/services that can perform the given bulk operation and include these as a dependency for your action.

## Examples

Expand Down Expand Up @@ -130,4 +130,4 @@ angular.module('vendr')
}]);
}]):

````
````
6 changes: 3 additions & 3 deletions content/core/1.8.0/key-concepts/search-specifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ var results = _orderService.SearchOrders(
.And(where.HasOrderNumber(orderNumber).Or(where.ByCustomer(customerEmail))))
````

The above is relatively simple example but it demonstrates the use of a delegate method that then uses a fluent specifications API to build up a query filter. The query filter itself can be made up of many different individual queries which themselves can be grouped using AND and OR query logic.
The above is a relatively simple example, but it demonstrates the use of a delegate method that then uses a fluent specifications API to build up a query filter. The query filter itself can be made up of many different individual queries, which themselves can be grouped using AND and OR query logic.

Because the API is fluent it is also self documenting, with Visual Studio intellisense able to guide developers through all the available specifications.
Because the API is fluent, it is also self-documenting, with Visual Studio Intellisense able to guide developers through all the available specifications.

## Ordering Results

Expand All @@ -42,4 +42,4 @@ var results = _orderService.SearchOrders(
(orderBy) => orderBy
.FinalizedDate(Sort.Descending)
.Then(orderBy.CreateDate(Sort.Descending)))
````
````
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public interface IVendrSettings

#### BackOfficeMvcArea

Gets the back office MVC area under which Vendr is installed
Gets the backoffice MVC area under which Vendr is installed

```csharp
public string BackOfficeMvcArea { get; }
Expand All @@ -28,7 +28,7 @@ public string BackOfficeMvcArea { get; }

#### BackOfficePath

Gets the back office path for this Vendr install
Gets the backoffice path for this Vendr install

```csharp
public string BackOfficePath { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public string Alias { get; }

#### AllowedAttributes

Gets the list of allowed Product Attribtues for this Product Attribute Preset
Gets the list of allowed Product Attributes for this Product Attribute Preset

```csharp
public IReadOnlyCollection<AllowedProductAttribute> AllowedAttributes { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public ProductVariantCollection(Guid storeId, IList<ProductVariantItem> list)

| Parameter | Description |
| --- | --- |
| storeId | The StoreId the product variants belogn to |
| storeId | The StoreId the product variants belong to |
| list | The list to wrap. |


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ public PagedResult<OrderReadOnly> SearchOrders(IQuerySpecification<OrderReadOnly
| Parameter | Description |
| --- | --- |
| query | The query specification to perform |
| sort | The sort order specification describinng the sort order in which to return the results |
| sort | The sort order specification describing the sort order in which to return the results |
| currentPage | The page of results of which to retrieve |
| itemsPerPage | The number of items per page to return |

Expand Down Expand Up @@ -344,7 +344,7 @@ public PagedResult<OrderReadOnly> SearchOrders(
| Parameter | Description |
| --- | --- |
| query | The factory method to generate the query specification to perform |
| sort | The factory method to generate the sort order specification describinng the sort order in which to return the results |
| sort | The factory method to generate the sort order specification describing the sort order in which to return the results |
| currentPage | The page of results of which to retrieve |
| itemsPerPage | The number of items per page to return |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ public void SetStock(string productReference, string productVariantReference, de

#### TryGetStock (1 of 2)

Trys to get the stock level of a given product
Tries to get the stock level of a given product

```csharp
public bool TryGetStock(string productReference, out decimal? stock)
Expand Down