@graphcommerce/docs 5.1.0 → 5.1.1-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 CHANGED
@@ -1,5 +1,11 @@
1
1
  # Change Log
2
2
 
3
+ ## 5.1.1-canary.0
4
+
5
+ ### Patch Changes
6
+
7
+ - [#1762](https://github.com/graphcommerce-org/graphcommerce/pull/1762) [`f7455e002`](https://github.com/graphcommerce-org/graphcommerce/commit/f7455e002259a71bb8db7ea0b8375134abf4ab50) - remove Developer preview snippet ([@paales](https://github.com/paales))
8
+
3
9
  ## 5.1.0
4
10
 
5
11
  ### Patch Changes
package/feature-list.md CHANGED
@@ -7,15 +7,6 @@ metaDescription:
7
7
  metaUrl: magento-open-source-full-feature-list-with-graphcommerce
8
8
  ---
9
9
 
10
- <div data-nosnippet>
11
-
12
- > **Developer preview**
13
- > This is a developer preview of GraphCommerce. The documentation will be
14
- > updated as GraphCommerce introduces
15
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
16
-
17
- </div>
18
-
19
10
  # Magento Open Source + GraphCommerce® full feature list
20
11
 
21
12
  <div className='tags'>
@@ -1,12 +1,3 @@
1
- <div data-nosnippet>
2
-
3
- > **Developer preview**
4
- > This is a developer preview of GraphCommerce. The documentation will be
5
- > updated as GraphCommerce introduces
6
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
7
-
8
- </div>
9
-
10
1
  # Deploy a Graphcommerce app with Vercel
11
2
 
12
3
  Congratulations, you are ready to deploy your GraphCommerce storefront to
@@ -1,12 +1,3 @@
1
- <div data-nosnippet>
2
-
3
- > **Developer preview**
4
- > This is a developer preview of GraphCommerce. The documentation will be
5
- > updated as GraphCommerce introduces
6
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
7
-
8
- </div>
9
-
10
1
  # Environment Variables
11
2
 
12
3
  This guide describes how to store environment variables in your GraphCommerce
@@ -2,15 +2,6 @@
2
2
  menu: GraphCMS
3
3
  ---
4
4
 
5
- <div data-nosnippet>
6
-
7
- > **Developer preview**
8
- > This is a developer preview of GraphCommerce. The documentation will be
9
- > updated as GraphCommerce introduces
10
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
11
-
12
- </div>
13
-
14
5
  # GraphCMS
15
6
 
16
7
  GraphCMS is integrated as a Content Management System. It is used to store all
@@ -1,12 +1,3 @@
1
- <div data-nosnippet>
2
-
3
- > **Developer preview**
4
- > This is a developer preview of GraphCommerce. The documentation will be
5
- > updated as GraphCommerce introduces
6
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
7
-
8
- </div>
9
-
10
1
  # Icons
11
2
 
12
3
  The GraphCommerce UI looks clean and minimalistic due to the use of icons. This
@@ -2,15 +2,6 @@
2
2
  menu: Overview
3
3
  ---
4
4
 
5
- <div data-nosnippet>
6
-
7
- > **Developer preview**
8
- > This is a developer preview of GraphCommerce. The documentation will be
9
- > updated as GraphCommerce introduces
10
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
11
-
12
- </div>
13
-
14
5
  # GraphCommerce framework overview
15
6
 
16
7
  GraphCommerce is a front-end framework used for building headless Magento
@@ -7,15 +7,6 @@ metaDescription:
7
7
  metaUrl: framework/static-generation-nextjs-ecommerce
8
8
  ---
9
9
 
10
- <div data-nosnippet>
11
-
12
- > **Developer preview**
13
- > This is a developer preview of GraphCommerce. The documentation will be
14
- > updated as GraphCommerce introduces
15
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
16
-
17
- </div>
18
-
19
10
  # Static Site Generation (SSG) in GraphCommerce
20
11
 
21
12
  Pages that export a function called getStaticProps, will pre-render at
@@ -1,12 +1,3 @@
1
- <div data-nosnippet>
2
-
3
- > **Developer preview**
4
- > This is a developer preview of GraphCommerce. The documentation will be
5
- > updated as GraphCommerce introduces
6
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
7
-
8
- </div>
9
-
10
1
  # Troubleshouting
11
2
 
12
3
  ## Common build errors
@@ -3,15 +3,6 @@ menu: 5. Build a GraphCMS component
3
3
  metaTitle: Build a GraphCMS component
4
4
  ---
5
5
 
6
- <div data-nosnippet>
7
-
8
- > **Developer preview**
9
- > This is a developer preview of GraphCommerce. The documentation will be
10
- > updated as GraphCommerce introduces
11
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
12
-
13
- </div>
14
-
15
6
  # Build a GraphCMS component
16
7
 
17
8
  Previously, you created a GraphCommerce app and started building a custom
@@ -3,15 +3,6 @@ menu: 3. Build a custom header
3
3
  metaTitle: Build a custom header
4
4
  ---
5
5
 
6
- <div data-nosnippet>
7
-
8
- > **Developer preview**
9
- > This is a developer preview of GraphCommerce. The documentation will be
10
- > updated as GraphCommerce introduces
11
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
12
-
13
- </div>
14
-
15
6
  # Build a custom header in GraphCommerce
16
7
 
17
8
  Previously, you created a GraphCommerce app and started building your custom
@@ -3,15 +3,6 @@ menu: 4. Build pages
3
3
  metaTitle: Build pages
4
4
  ---
5
5
 
6
- <div data-nosnippet>
7
-
8
- > **Developer preview**
9
- > This is a developer preview of GraphCommerce. The documentation will be
10
- > updated as GraphCommerce introduces
11
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
12
-
13
- </div>
14
-
15
6
  # Build pages in GraphCommerce
16
7
 
17
8
  Previously, you created a custom storefront and started customizing your
@@ -10,15 +10,6 @@ metaDescription:
10
10
  metaUrl: getting-started/getting-started-with-magento-react-ecommerce
11
11
  ---
12
12
 
13
- <div data-nosnippet>
14
-
15
- > **Developer preview**
16
- > This is a developer preview of GraphCommerce. The documentation will be
17
- > updated as GraphCommerce introduces
18
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
19
-
20
- </div>
21
-
22
13
  # GraphCommerce magento-graphcms example overview
23
14
 
24
15
  GraphCommerce offers a magento-graphcms example that provides an approachable
@@ -3,15 +3,6 @@ menu: 2. Customize a storefront
3
3
  metaTitle: Customize a storefront
4
4
  ---
5
5
 
6
- <div data-nosnippet>
7
-
8
- > **Developer preview**
9
- > This is a developer preview of GraphCommerce. The documentation will be
10
- > updated as GraphCommerce introduces
11
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
12
-
13
- </div>
14
-
15
6
  # Start building a GraphCommerce custom storefront
16
7
 
17
8
  Previously, you [created a new GraphCommerce app](../getting-started/create.md).
@@ -1,4 +1,19 @@
1
- # Magento payment gateway requirements
1
+ ---
2
+ menu: Payment methods
3
+ ---
4
+
5
+ # Magento Payment methods
6
+
7
+ Currently supported methods:
8
+
9
+ - [PayPal](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/magento-payment-paypal)
10
+ - [Mollie](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/mollie-magento-payment)
11
+ - [Braintree](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/magento-payment-braintree)
12
+ - [Adyen](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/magento-payment-adyen)
13
+ - [MultiSafePay](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/magento-payment-multisafepay)
14
+ - [Klarna](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/magento-payment-klarna)
15
+
16
+ ## Creating a Magento compatible payment gateway
2
17
 
3
18
  Payment gateways are the most important part of any e-commerce store. In this
4
19
  section, we will discuss the requirements for implementing a payment gateway in
@@ -6,7 +21,7 @@ Magento 2 that is compatible with GraphCommerce.
6
21
 
7
22
  There are multiple flows to handle payments.
8
23
 
9
- ## Flow 1: Redirecting payment gateway
24
+ ### Redirecting payment gateway
10
25
 
11
26
  The first step is to call setPaymentMethodOnCart and placeOrder.
12
27
 
@@ -166,3 +181,7 @@ enum MyGatewayStatusEnum {
166
181
  SUCCESS
167
182
  }
168
183
  ```
184
+
185
+ ## Next steps
186
+
187
+ - [Overview](./readme)
package/magento/readme.md CHANGED
@@ -1,3 +1,7 @@
1
+ ---
2
+ menu: Overview
3
+ ---
4
+
1
5
  # Magento
2
6
 
3
7
  To integrate with Magento, most of the functionality should work out-of-the box
@@ -15,3 +19,8 @@ if Magento exposes a working GraphQL API.
15
19
  - [Adyen](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/magento-payment-adyen)
16
20
  - [MultiSafePay](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/magento-payment-multisafepay)
17
21
  - [Klarna](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/magento-payment-klarna)
22
+
23
+ ## Next steps
24
+
25
+ - [Full feature list](../feature-list.md)
26
+ - [SEO Migration](./seo-migration.md)
@@ -1,3 +1,7 @@
1
+ ---
2
+ menu: SEO Migration
3
+ ---
4
+
1
5
  # SEO Migration
2
6
 
3
7
  GraphCommerce uses a different URL structure than default Magento to achieve
@@ -8,7 +12,6 @@ better performance.
8
12
  - Products have a different URL structure: `/p/[url]`. e.g.
9
13
  `/p/my-product-url-key`.
10
14
  - Categories use same URL structure: `/[...url]`. e.g. `/my/category/path`.
11
-
12
15
  - GraphCommerce does not use any URL suffixes. e.g. `.html`.
13
16
 
14
17
  ## Why doesn't GraphCommerce support full URL rewrites?
@@ -32,3 +35,9 @@ A permanent redirect for product and category paths ending in the configured
32
35
  suffix (e.g. `.html`) is made automatically.
33
36
 
34
37
  Categories use the same URL structure as Magento, no redirection there.
38
+
39
+ Redirects provided by Magento are automatically handled.
40
+
41
+ ## Next steps
42
+
43
+ - [Overview](./readme)
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": "5.1.0",
5
+ "version": "5.1.1-canary.0",
6
6
  "sideEffects": true,
7
7
  "devDependencies": {
8
- "@graphcommerce/prettier-config-pwa": "5.1.0"
8
+ "@graphcommerce/prettier-config-pwa": "5.1.1-canary.0"
9
9
  },
10
10
  "prettier": "@graphcommerce/prettier-config-pwa"
11
11
  }
package/readme.md CHANGED
@@ -8,15 +8,6 @@ metaDescription:
8
8
  extension.'
9
9
  ---
10
10
 
11
- <div data-nosnippet>
12
-
13
- > **Developer preview**
14
- > This is a developer preview of GraphCommerce. The documentation will be
15
- > updated as GraphCommerce introduces
16
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
17
-
18
- </div>
19
-
20
11
  # GraphCommerce
21
12
 
22
13
  GraphCommerce is a front-end framework used for building headless Magento
package/upgrading.md CHANGED
@@ -1,12 +1,3 @@
1
- <div data-nosnippet>
2
-
3
- > **Developer preview**
4
- > This is a developer preview of GraphCommerce. The documentation will be
5
- > updated as GraphCommerce introduces
6
- > [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
7
-
8
- </div>
9
-
10
1
  # Upgrading
11
2
 
12
3
  This guide describes how to upgrade your GraphCommerce project files and its