@graphcommerce/docs 9.0.0-canary.72 → 9.0.0-canary.73

package/CHANGELOG.md

@@ -1,5 +1,7 @@
 # Change Log
 
+## 9.0.0-canary.73
+
 ## 9.0.0-canary.72
 
 ## 9.0.0-canary.71

package/framework/config.md

@@ -85,6 +85,22 @@ Below is a list of all possible configurations that can be set by GraphCommerce.
 
 ### GraphCommerceConfig
 
+#### algoliaApplicationId: string (required)
+
+Configure your Algolia application ID.
+
+Stores > Configuration > Algolia Search > Credentials and Basic Setup > Application ID
+
+#### algoliaIndexNamePrefix: string (required)
+
+Stores > Configuration > Algolia Search > Credentials and Basic Setup > Index name prefix
+
+#### algoliaSearchOnlyApiKey: string (required)
+
+Configure your Algolia Search Only API Key.
+
+Stores > Configuration > Algolia Search > Credentials and Basic Setup > Search-only (public) API key
+
 #### canonicalBaseUrl: string (required)
 
 The canonical base URL is used for SEO purposes.
@@ -119,6 +135,12 @@ Values: 245, 246, 247 for Magento 2.4.5, 2.4.6, 2.4.7 respectively.
 
 All storefront configuration for the project
 
+#### algoliaCatalogEnabled: boolean
+
+By default the catalog will not use algolia. Set this to true to enable Algolia for the catalog.
+
+#### algoliaCustomerGroupPricingEnabled: boolean
+
 #### breadcrumbs: boolean = `false`
 
 Configuration for the SidebarGallery component
@@ -243,17 +265,15 @@ This value is required even if you are configuring different values for each loc
 
 Hygraph Management API. **Only used for migrations.**
 
+Optional: If the hygraphEndpoint is configured with the 'High Performance Content
+API', this field is not required.
+
 #### hygraphProjectId: string
 
 Hygraph Project ID. **Only used for migrations.**
 
-#### hygraphWriteAccessEndpoint: string
-
-Content API. **Only used for migrations.**
-
-> Regular read & write endpoint that allows querying and mutating data in your project.
-
-Project settings -> API Access -> Content API
+Optional: If the hygraphEndpoint is configured with the 'High Performance Content
+API', this field is not required.
 
 #### hygraphWriteAccessToken: string
 
@@ -282,7 +302,6 @@ Project settings -> API Access -> Permanent Auth Tokens
   - Can see schema view
 
 ```
-GC_HYGRAPH_WRITE_ACCESS_ENDPOINT="https://...hygraph.com/v2/..."
 GC_HYGRAPH_WRITE_ACCESS_TOKEN="AccessTokenFromHygraph"
 yarn graphcommerce hygraph-migrate
 ```
@@ -390,6 +409,10 @@ Examples:
 - en-us
 - b2b-us
 
+#### algoliaIndexNamePrefix: string
+
+Stores > Configuration > Algolia Search > Credentials and Basic Setup > Index name prefix
+
 #### canonicalBaseUrl: string
 
 The canonical base URL is used for SEO purposes.

package/hygraph/cli.md

@@ -50,18 +50,24 @@ The following steps are needed to utilize this tool:
       - Can see schema view
    5. Add this new token to your env file:
       `GC_HYGRAPH_WRITE_ACCESS_TOKEN="{YOUR_WRITE_ACCESS_TOKEN}"`
-2. Add the Content API key to your env file like this:
-   1. Open your Hygraph project. Go to: Project settings -> API Access
-   2. Copy the Content API URL and add to your env file:
-      `GC_HYGRAPH_WRITE_ACCESS_ENDPOINT="{YOUR_WRITE_ACCESS_ENDPOINT}"`
-3. Add your hygraphProjectId to your env file like this:
-   1. Copy the project ID from the URL when logged in
-      `https://app.hygraph.com/PROJECT_ID_IS_HERE/master`
-   2. Add the project ID to your env file:
-      `GC_HYGRAPH_PROJECT_ID="{YOUR_PROJECT_ID}"`
-4. Add your hygraphManagementApi to your env file like this:
-   1. Copy the Management API URL and add to your env file: `GC_HYGRAPH_MANAGEMENT_API="{YOUR_MANAGEMENT_API}"`
-5. Run `yarn graphcommerce hygraph-migrate`
-6. Select the migration you want to run and press enter.
-7. The migrations should now be applied, check your Hygraph Schema if changes
+2. Run `yarn graphcommerce hygraph-migrate`
+3. Select the migration you want to run and press enter.
+4. The migrations should now be applied, check your Hygraph Schema if changes
    are made.
+
+### Addtional config
+
+These configurations should not be necessary and can be deduced from the
+hygraphEndpoint URL. This allows you to override them in case something goes
+wrong.
+
+Before adding these make sure you've configure the 'High Performance Content
+API' als your hygraphEndpoint.
+
+- Add your hygraphProjectId to your env file like this:
+  1.  Settings > Project > Id
+  2.  Add the project ID to your env file:
+      `GC_HYGRAPH_PROJECT_ID="{YOUR_PROJECT_ID}"`
+- Add your hygraphManagementApi to your env file like this:
+  1.  Copy the Management API URL and add to your env file:
+      `GC_HYGRAPH_MANAGEMENT_API="{YOUR_MANAGEMENT_API}"`

package/package.json

@@ -2,10 +2,10 @@
   "name": "@graphcommerce/docs",
   "homepage": "https://www.graphcommerce.org/docs",
   "repository": "github:graphcommerce-org/graphcommerce/docs",
-  "version": "9.0.0-canary.72",
+  "version": "9.0.0-canary.73",
   "sideEffects": true,
   "peerDependencies": {
-    "@graphcommerce/prettier-config-pwa": "^9.0.0-canary.72"
+    "@graphcommerce/prettier-config-pwa": "^9.0.0-canary.73"
   },
   "prettier": "@graphcommerce/prettier-config-pwa"
 }