@graphcommerce/docs 10.0.2 → 10.0.3-canary.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -0
- package/framework/config.md +0 -77
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
package/framework/config.md
CHANGED
|
@@ -7,73 +7,6 @@ GoogleDatalayerConfig to allow enabling certain aspects of the datalayer
|
|
|
7
7
|
|
|
8
8
|
Enable core web vitals tracking for GraphCommerce
|
|
9
9
|
|
|
10
|
-
### GraphCommerceAlgoliaConfig
|
|
11
|
-
|
|
12
|
-
Algolia configuration for GraphCommerce.
|
|
13
|
-
|
|
14
|
-
#### applicationId: string (required)
|
|
15
|
-
|
|
16
|
-
Configure your Algolia application ID. [Algolia API Keys Dashboard](https://www.algolia.com/account/api-keys)
|
|
17
|
-
|
|
18
|
-
#### indexNamePrefix: string (required)
|
|
19
|
-
|
|
20
|
-
Stores > Configuration > Algolia Search > Credentials and Basic Setup > Index name prefix
|
|
21
|
-
|
|
22
|
-
#### searchOnlyApiKey: string (required)
|
|
23
|
-
|
|
24
|
-
Configure your Search API Key. [Algolia API Keys Dashboard](https://www.algolia.com/account/api-keys)
|
|
25
|
-
|
|
26
|
-
Make sure the API key has the following ACL: search, listIndexes and settings [Lookup here](https://dashboard.algolia.com/account/api-keys/restricted)
|
|
27
|
-
|
|
28
|
-
#### catalogEnabled: boolean
|
|
29
|
-
|
|
30
|
-
By default the catalog will not use algolia. Set this to true to enable Algolia for the catalog.
|
|
31
|
-
|
|
32
|
-
#### customerGroupPricingEnabled: boolean
|
|
33
|
-
|
|
34
|
-
Enable Algolia customer group pricing.
|
|
35
|
-
|
|
36
|
-
Please be aware that personalization needs to be enabled to make this work.
|
|
37
|
-
|
|
38
|
-
#### frequentlyBoughtTogether: CROSSSELL_PRODUCTS | DISABLED | RELATED_PRODUCTS | UPSELL_PRODUCTS
|
|
39
|
-
|
|
40
|
-
https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together
|
|
41
|
-
|
|
42
|
-
Set the location where the frequently bought together model should be shown.
|
|
43
|
-
Good default is CROSSSELL_PRODUCTS, which is shown on the Cart page.
|
|
44
|
-
|
|
45
|
-
Before enabling, make sure the model is trained in Algolia.
|
|
46
|
-
Do not assign multiple recommendation models to the same location.
|
|
47
|
-
|
|
48
|
-
#### lookingSimilar: CROSSSELL_PRODUCTS | DISABLED | RELATED_PRODUCTS | UPSELL_PRODUCTS
|
|
49
|
-
|
|
50
|
-
https://www.algolia.com/doc/guides/algolia-recommend/overview/#looking-similar
|
|
51
|
-
|
|
52
|
-
Set the location where the looking similar model should be shown.
|
|
53
|
-
Good default is UPSELL_PRODUCTS, which is shown on the Product page by default.
|
|
54
|
-
|
|
55
|
-
Before enabling, make sure the model is trained in Algolia.
|
|
56
|
-
Do not assign multiple recommendation models to the same location.
|
|
57
|
-
|
|
58
|
-
#### relatedProducts: CROSSSELL_PRODUCTS | DISABLED | RELATED_PRODUCTS | UPSELL_PRODUCTS
|
|
59
|
-
|
|
60
|
-
https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content
|
|
61
|
-
|
|
62
|
-
Set the location where the related products model should be shown.
|
|
63
|
-
Good default is RELATED_PRODUCTS, which is shown on the Product page by default.
|
|
64
|
-
|
|
65
|
-
Before enabling, make sure the model is trained in Algolia.
|
|
66
|
-
Do not assign multiple recommendation models to the same location.
|
|
67
|
-
|
|
68
|
-
#### suggestionsSuffix: string
|
|
69
|
-
|
|
70
|
-
To enable Algolia suggestions, please provide the Suffix that is used for your suggestions index.
|
|
71
|
-
|
|
72
|
-
The pattern is `${indexNamePrefix}_{storeCode}_{suggestionsSuffix}`.
|
|
73
|
-
Something like `_suggestions` or `_query_suggestions`
|
|
74
|
-
|
|
75
|
-
For the index `magento2_demo_en_US_suggestions` this would be `_suggestions`
|
|
76
|
-
|
|
77
10
|
# GraphCommerce configuration system
|
|
78
11
|
|
|
79
12
|
Global GraphCommerce configuration can be configured in your `graphcommerce.config.js` file
|
|
@@ -152,12 +85,6 @@ Below is a list of all possible configurations that can be set by GraphCommerce.
|
|
|
152
85
|
|
|
153
86
|
### GraphCommerceConfig
|
|
154
87
|
|
|
155
|
-
#### algolia: [GraphCommerceAlgoliaConfig](#GraphCommerceAlgoliaConfig) (required)
|
|
156
|
-
|
|
157
|
-
Configure your Algolia application ID.
|
|
158
|
-
|
|
159
|
-
Stores > Configuration > Algolia Search > Credentials and Basic Setup > Application ID
|
|
160
|
-
|
|
161
88
|
#### canonicalBaseUrl: string (required)
|
|
162
89
|
|
|
163
90
|
The canonical base URL is used for SEO purposes.
|
|
@@ -472,10 +399,6 @@ Allows customers to change their billing address or locks it down.
|
|
|
472
399
|
|
|
473
400
|
Changes the availability of the add to cart buttons and the cart page to either customer only or completely disables it.
|
|
474
401
|
|
|
475
|
-
#### catalogPricing: CUSTOMER_ONLY | ENABLED
|
|
476
|
-
|
|
477
|
-
Permissions to show the catalog pricing on the frontend.
|
|
478
|
-
|
|
479
402
|
#### checkout: CUSTOMER_ONLY | DISABLED | ENABLED
|
|
480
403
|
|
|
481
404
|
Changes the availability of the checkout to either customer only or completely disables it.
|
package/package.json
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
"name": "@graphcommerce/docs",
|
|
3
3
|
"homepage": "https://www.graphcommerce.org/docs",
|
|
4
4
|
"repository": "github:graphcommerce-org/graphcommerce/docs",
|
|
5
|
-
"version": "10.0.
|
|
5
|
+
"version": "10.0.3-canary.0",
|
|
6
6
|
"sideEffects": true,
|
|
7
7
|
"peerDependencies": {
|
|
8
|
-
"@graphcommerce/prettier-config-pwa": "^10.0.
|
|
8
|
+
"@graphcommerce/prettier-config-pwa": "^10.0.3-canary.0"
|
|
9
9
|
},
|
|
10
10
|
"prettier": "@graphcommerce/prettier-config-pwa"
|
|
11
11
|
}
|