Skip to content

Commit 96019cc

Browse files
committed
Move some commerce docs around, add a few tweaks here and there, and enable it to be built on the live docs site
1 parent 21c0eaa commit 96019cc

28 files changed

+19
-12
lines changed

config.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
},
99
"ignore": {
1010
"files": [".bower-postinstall.sh", ".bowerrc", "bower.json", "build.sh", ".gitignore", "README.md", "html.zip", "circle.yml", "package.json", "composer.json", "composer.lock", "deploy.sh", "error_log"],
11-
"folders": ["html", "node_modules", "src", ".idea", "themes", "vendor", "01_Commerce"]
11+
"folders": ["html", "node_modules", "src", ".idea", "themes", "vendor"]
1212
},
1313
"languages": { "en": "English" }
1414
}

en/01_Commerce/v1/00_Getting_Started.md en/01_Commerce/v1/01_Getting_Started.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ Commerce is a full featured ecommerce solution for MODX, but you have to start s
44

55
Without the package, none of the other steps will make sense! So purchase a license (or [use a free development license](https://www.modmore.com/free-development-licenses/)) and install the Commerce transport package in your MODX Revolution site.
66

7-
Keep an eye on the Server Requirements as Commerce demands slightly more than our other packages.
7+
Keep an eye on the [Requirements](Requirements) as Commerce demands slightly more than our other packages.
88

99
Once installed, you're ready to start building your webshop.
1010

1111
## Step 2: Choose your Modules
1212

13-
Many of the Commerce features are implemented as Modules. While they are tightly integrated, they are all optional so you can use as little or as many as you'd like.
13+
Many of the Commerce features are implemented as [Modules](Modules). While they are tightly integrated, they are all optional so you can use as little or as many as you'd like.
1414

1515
Many modules ship with the core package. Others can be installed separately and may require an additional purchase.
1616

@@ -38,11 +38,11 @@ Let's now create some products to add to the cart.
3838

3939
## Step 4: Create your first Product
4040

41-
Commerce allows you to build and manage your catalog in various ways, but they all share one thing. This is the Product record.
41+
Commerce allows you to build and manage your catalog in various ways, but they all share one thing. This is the Product record. To understand the difference between a _product_ and your _catalog_, [read the Product Catalog documentation](Product_Catalog).
4242

4343
In some cases you might automatically create the Commerce Product records based on information in your catalog. For simple shops you might use the provided Product and Category features for your catalog as well.
4444

45-
To get you started, we'll just create a product record directly. Go to Extras > Commerce and click the Add new Product button on the Products page. In the popup enter the product details, and click save.
45+
To get you started, we'll just create a product record directly. Go to Extras > Commerce and click the Add new Product button on the Products tab. In the popup enter the product details, and click save.
4646

4747
Add a form like this anywhere on your site, replacing 1 with the ID of the newly created product if needed.
4848

@@ -59,6 +59,8 @@ Add a form like this anywhere on your site, replacing 1 with the ID of the newly
5959

6060
Visit that page in the front-end, click the Add to Cart button and voila - you should have the product in your cart!
6161

62+
Obviously this is not the best way to manage your catalog. The [Product Catalog](Product_Catalog) page has more information on the different options available to you with Commerce.
63+
6264
## Step 5: Checking out
6365

6466
While carts are useful, you will also need a checkout to allow people to pay. Create a new Checkout resource, and place the following uncached snippet call in it:
@@ -79,5 +81,4 @@ At this point you should have a basic, but functional shop.
7981

8082
You're not done though! You'll probably want to build up a larger catalog, tweak the design of the cart and checkout or explore the different modules you can use.
8183

82-
If you're unsure on how to approach certain features, or have any other questions about Commerce, please reach out to our team. We have a community forum, as well as email support, and we would love to help you make the most out of Commerce in either of those venues.
83-
84+
If you're unsure on how to approach certain features, or have any other questions about Commerce, please reach out to our team. We have a [community forum](https://forum.modmore.com/c/commerce), [FAQs](https://support.modmore.com/faq/13-commerce), as well as email support once you've purchased a license, and we would love to help you make the most out of Commerce.

en/01_Commerce/v1/01_Front-end_Theming.md en/01_Commerce/v1/03_Front-end_Theming.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ If it finds the requested template file, it stops there, otherwise it checks the
4545

4646
With Contexts in MODX, you can use different Commerce themes for different contexts. To use this, create `commerce.theme` and/or `commerce.themes_path` context settings for the specific context.
4747

48-
Note that the Commerce admin area will not use context-specific themes unless you specify the setting on the `mgr` context.
48+
Note that the Commerce admin area will not use context-specific themes unless you specify the setting on the `mgr` context. We don't recommend making changes to the manager dashboard for now, to ensure things don't break in a weird way while we continue to evolve that.
4949

5050
## Different themes for User (Groups)
5151

File renamed without changes.
File renamed without changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
The EU Vat Module is shipped with the Commerce core. It needs to be enabled before use via Configuration > Modules.
2+
3+
The EU VAT Module is used to apply the standard VAT rate for the customer's country to all items in the cart. It retrieves the current VAT rates from [euvatrates.com](https://euvatrates.com/) and caches them for 3 days.
4+
5+
The module does not currently validate or apply different rules depending on the customers' VAT registration number, if provided, but that's something that we intend to add before the beta release.

en/01_Commerce/v1/Modules/Cart/CombineProducts.md en/01_Commerce/v1/50_Modules/Cart/CombineProducts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The EUVat Module is shipped with the Commerce core. It needs to be enabled before use via Configuration > Modules.
1+
The CombineProducts Module is shipped with the Commerce core. It needs to be enabled before use via Configuration > Modules.
22

33
The CombineProducts module runs when products are added to the cart, and makes sure that there is only ever a single row of a specific product (based on SKU and price) in the cart. Additional products are combined into a single cart row.
44

File renamed without changes.
File renamed without changes.

en/01_Commerce/v1/Modules/04_Taxes/EUVat.md

-3
This file was deleted.

en/01_Commerce/v1/index.md

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ description: Documentation for Commerce, a premium extra from modmore for MODX.
55

66
[Commerce](https://www.modmore.com/commerce/) brings a flexible and easy to use e-commerce solution to MODX.
77

8+
**Commerce is currently in ALPHA.** This means it is only available if you've been invited, and that the features and documentation are still fairly basic. With the help of our alpha testers we'll be finishing the version 1.0 features before the beta starts (around February/March). Licenses for production use will not be available until we hit beta.
9+
10+
If you'd like to join the Alpha or Beta, please email [email protected]. Keep in mind we already have a fairly long list of people waiting, so you may not get access to Commerce for some time when you only sign up now.
11+
812
# Recommended Reading
913

1014
- [Getting Started](Getting_Started)

0 commit comments

Comments
 (0)