Add grammar and language changes #1147

Isengo1989 · 2023-10-20T08:17:41Z

dfs

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

concepts2/framework/rules.md|48 col 293| The plural noun “Criteria” cannot be used with the article “A”. (A_NNS[5])
Suggestions: A Search criterion, Search Criteria
Rule: https://community.languagetool.org/rule/show/A_NNS?lang=en-US&subId=5
Category: GRAMMAR

github-actions · 2023-10-20T09:00:57Z

concepts2/commerce/catalog/products.md

+
+However, it is also useful to attach some additional properties to differentiate product variants next to the field inheritance. For that reason, it is critical to understand the difference between *properties* and *options*:
+
+**Properties** are used to model facts about a product, but usually, different product variants share these facts. We can refer to properties as *non variant defining*. They could be useful to represent the following information:


[LanguageTool] _{reported by reviewdog 🐶}
This expression is usually spelled with a hyphen. (NON_ANTI_JJ[1])
Suggestions: non-variant
URL: https://languagetool.org/insights/post/nationalities/#hyphenation-of-national-identities
Rule: https://community.languagetool.org/rule/show/NON_ANTI_JJ?lang=en-US&subId=1
Category: COLLOCATIONS

github-actions · 2023-10-20T09:00:57Z

concepts2/commerce/checkout-concept/cart.md

+
+### Performance
+
+The cart is designed by identifying key processes and optimizing upon them. Therefore the amount of calculations, queries, and iterations are kept to a minimum, and a clear state management is implemented.


[LanguageTool] _{reported by reviewdog 🐶}
A comma may be missing after the conjunctive/linking adverb ‘Therefore’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[1])
Suggestions: Therefore,
URL: https://languagetool.org/insights/post/linking-words/
Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=1
Category: PUNCTUATION

github-actions · 2023-10-20T09:00:58Z

concepts2/commerce/checkout-concept/cart.md

+
+* It may be a  shippable good, a download article, or even a bundle of many products.
+* Line items contain properties that tell the cart how to handle changes in line items. E.g., *stackable* - quantity can be changed, *removable* - removable through the API, and so on.
+* A line item is the main extension point for the cart process. Therefore a promotion, a discount, or a surcharge is also a line item.


[LanguageTool] _{reported by reviewdog 🐶}
A comma may be missing after the conjunctive/linking adverb ‘Therefore’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[1])
Suggestions: Therefore,
URL: https://languagetool.org/insights/post/linking-words/
Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=1
Category: PUNCTUATION

github-actions · 2023-10-20T09:00:58Z

concepts2/commerce/checkout-concept/cart.md

+
+## Calculation
+
+Calculating a cart is one of the more costly operations an ecommerce system must support. Therefore the interfaces of the cart are designed as precise and as quick as possible. The calculation is a multi-stage process that revolves around the mutation of the data structure of the cart struct shown in the diagram below:


[LanguageTool] _{reported by reviewdog 🐶}
A comma may be missing after the conjunctive/linking adverb ‘Therefore’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[1])
Suggestions: Therefore,
URL: https://languagetool.org/insights/post/linking-words/
Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=1
Category: PUNCTUATION

github-actions · 2023-10-20T09:00:58Z

concepts2/commerce/checkout-concept/cart.md

+
+Enrichment secures the *Independence_ and _Adaptability* of Shopware 6. As shown in the below code snippet, the cart can create and contain line items that are initially empty and will only be loaded \(enriched\) during the calculation.
+
+```php


[LanguageTool] _{reported by reviewdog 🐶}
File types are normally capitalized. (FILE_EXTENSIONS_CASE[1])
Suggestions: PHP
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/FILE_EXTENSIONS_CASE?lang=en-US&subId=1
Category: CASING

github-actions · 2023-10-20T09:01:00Z

concepts2/framework/elasticsearch.md

+### ElasticsearchEntitySearcher
+
+The `ElasticsearchEntitySearcher` decorates the `EntitySearcher` to map the entity search to the Elasticsearch structure.
+The `ElasticsearchEntitySearcher` returns an `IdSearchResult` hydrated by the `ElasticsearchEntitySearchHydrator` as the `EntitySearcher` does, and this result is used to read the found ids from the database.


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: IDs
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

github-actions · 2023-10-20T09:01:00Z

concepts2/framework/http_cache.md

+
+The called route needs an `@HttpCache` annotation. Examples for this can be found in the [ProductController](https://github.com/shopware/shopware/blob/v6.3.4.1/src/Storefront/Controller/ProductController.php#L86).
+
+```php


[LanguageTool] _{reported by reviewdog 🐶}
File types are normally capitalized. (FILE_EXTENSIONS_CASE[1])
Suggestions: PHP
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/FILE_EXTENSIONS_CASE?lang=en-US&subId=1
Category: CASING

github-actions · 2023-10-20T09:01:00Z

concepts2/framework/http_cache.md

+
+#### sw-cache-hash
+
+This cookie replaces the `sw-currency` cookie and contains the active rules and active currency. This cookie will be set when the active rules do not match the default anymore \(e.g., customer login/items in cart\).


[LanguageTool] _{reported by reviewdog 🐶}
Make sure that ‘anymore’ is used as an adverb, not as an adjective. Did you mean “any more”? (ANYMORE_ADVERB[1])
Suggestions: any more
URL: https://www.grammarphobia.com/blog/2011/04/anymore-3.html
Rule: https://community.languagetool.org/rule/show/ANYMORE_ADVERB?lang=en-US&subId=1
Category: GRAMMAR

github-actions · 2023-10-20T09:01:00Z

concepts2/framework/rules.md

+
+# Rules
+
+The rule system pervades Shopware 6. It solves the problem of calculating the cart differently based on the context \([`SalesChannel`](../commerce/catalog/sales-channels), `CustomerGroup`, etc\) and the current state \([`LineItems`](../commerce/checkout-concept/cart#line-items), `Amount`, etc\), but user controlled and decoupled from the [cart](../commerce/checkout-concept/cart) itself. In theory, [every part of Shopware 6](../../resources/references/core-reference/rules-reference) can contribute to the set of available rules.


[LanguageTool] _{reported by reviewdog 🐶}
A period is needed after the abbreviation ‘etc.’ (ETC_PERIOD[1])
Suggestions: etc.
URL: https://languagetool.org/insights/post/spelling-etc-or-ect/
Rule: https://community.languagetool.org/rule/show/ETC_PERIOD?lang=en-US&subId=1
Category: AMERICAN_ENGLISH_STYLE

github-actions · 2023-10-20T09:01:00Z

concepts2/framework/rules.md

+
+# Rules
+
+The rule system pervades Shopware 6. It solves the problem of calculating the cart differently based on the context \([`SalesChannel`](../commerce/catalog/sales-channels), `CustomerGroup`, etc\) and the current state \([`LineItems`](../commerce/checkout-concept/cart#line-items), `Amount`, etc\), but user controlled and decoupled from the [cart](../commerce/checkout-concept/cart) itself. In theory, [every part of Shopware 6](../../resources/references/core-reference/rules-reference) can contribute to the set of available rules.


[LanguageTool] _{reported by reviewdog 🐶}
A period is needed after the abbreviation ‘etc.’ (ETC_PERIOD[1])
Suggestions: etc.
URL: https://languagetool.org/insights/post/spelling-etc-or-ect/
Rule: https://community.languagetool.org/rule/show/ETC_PERIOD?lang=en-US&subId=1
Category: AMERICAN_ENGLISH_STYLE

Isengo1989 added 3 commits October 20, 2023 10:17

Add grammar and language changes

81aba84

Add grammar and language changes

43d8875

Test folder addition

92d67d6

github-actions bot reviewed Oct 20, 2023

View reviewed changes

Isengo1989 marked this pull request as draft October 23, 2023 06:16

bojanrajh changed the base branch from main to v6.5 November 22, 2023 10:43

Test

467227d

bojanrajh changed the base branch from v6.5 to main November 23, 2023 20:59

Isengo1989 and others added 5 commits November 24, 2023 11:32

Add link checker

053615f

Add link checker

4b99368

Add link checker

d2acf33

Bring back guides folder

1447385

feat: use forked repo

d3c450f

Isengo1989 closed this Nov 29, 2023

bojanrajh deleted the dx-adhoc/grammar-language branch October 16, 2024 10:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add grammar and language changes #1147

Add grammar and language changes #1147

Isengo1989 commented Oct 20, 2023 •

edited

Loading

github-actions bot left a comment

github-actions bot Oct 20, 2023

github-actions bot Oct 20, 2023

github-actions bot Oct 20, 2023

github-actions bot Oct 20, 2023

github-actions bot Oct 20, 2023

github-actions bot Oct 20, 2023

github-actions bot Oct 20, 2023

github-actions bot Oct 20, 2023

github-actions bot Oct 20, 2023

github-actions bot Oct 20, 2023


		However, it is also useful to attach some additional properties to differentiate product variants next to the field inheritance. For that reason, it is critical to understand the difference between properties and options:

		Properties are used to model facts about a product, but usually, different product variants share these facts. We can refer to properties as non variant defining. They could be useful to represent the following information:


		### Performance

		The cart is designed by identifying key processes and optimizing upon them. Therefore the amount of calculations, queries, and iterations are kept to a minimum, and a clear state management is implemented.


		## Calculation

		Calculating a cart is one of the more costly operations an ecommerce system must support. Therefore the interfaces of the cart are designed as precise and as quick as possible. The calculation is a multi-stage process that revolves around the mutation of the data structure of the cart struct shown in the diagram below:


		Enrichment secures the Independence_ and _Adaptability of Shopware 6. As shown in the below code snippet, the cart can create and contain line items that are initially empty and will only be loaded \(enriched\) during the calculation.

		```php


		The called route needs an `@HttpCache` annotation. Examples for this can be found in the [ProductController](https://github.com/shopware/shopware/blob/v6.3.4.1/src/Storefront/Controller/ProductController.php#L86).

		```php


		#### sw-cache-hash

		This cookie replaces the `sw-currency` cookie and contains the active rules and active currency. This cookie will be set when the active rules do not match the default anymore \(e.g., customer login/items in cart\).


		# Rules

		The rule system pervades Shopware 6. It solves the problem of calculating the cart differently based on the context \([`SalesChannel`](../commerce/catalog/sales-channels), `CustomerGroup`, etc\) and the current state \([`LineItems`](../commerce/checkout-concept/cart#line-items), `Amount`, etc\), but user controlled and decoupled from the [cart](../commerce/checkout-concept/cart) itself. In theory, [every part of Shopware 6](../../resources/references/core-reference/rules-reference) can contribute to the set of available rules.

Add grammar and language changes #1147

Add grammar and language changes #1147

Conversation

Isengo1989 commented Oct 20, 2023 • edited Loading

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Oct 20, 2023

Choose a reason for hiding this comment

github-actions bot Oct 20, 2023

Choose a reason for hiding this comment

github-actions bot Oct 20, 2023

Choose a reason for hiding this comment

github-actions bot Oct 20, 2023

Choose a reason for hiding this comment

github-actions bot Oct 20, 2023

Choose a reason for hiding this comment

github-actions bot Oct 20, 2023

Choose a reason for hiding this comment

github-actions bot Oct 20, 2023

Choose a reason for hiding this comment

github-actions bot Oct 20, 2023

Choose a reason for hiding this comment

github-actions bot Oct 20, 2023

Choose a reason for hiding this comment

github-actions bot Oct 20, 2023

Choose a reason for hiding this comment

Isengo1989 commented Oct 20, 2023 •

edited

Loading