Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Re-organize Developer section
Damian Legawiec445fd15d2968
diff --git a/guides/gatsby-node.js b/guides/gatsby-node.jsindex 85f35e2943..83933f69ca 100644--- a/guides/gatsby-node.js+++ b/guides/gatsby-node.js@@ -52,6 +52,14 @@ exports.createPages = ({ actions, graphql }) => {})}+const fixSlug = slug => {+ if (!slug.match(/release_notes/)) {+ return slug.replace(/\/\d+\_/, '/')+ } else {+ return slug+ }+}+exports.onCreateNode = ({ node, getNode, actions }) => {const { createNodeField } = actions@@ -74,7 +82,7 @@ exports.onCreateNode = ({ node, getNode, actions }) => {createNodeField({node,name: 'slug',- value: isIndex ? slug : slugWithExt+ value: fixSlug(isIndex ? slug : slugWithExt)})createNodeField({diff --git a/guides/src/components/Sidebar.js b/guides/src/components/Sidebar.jsindex 449c0c3e7d..596da5f461 100644--- a/guides/src/components/Sidebar.js+++ b/guides/src/components/Sidebar.js@@ -81,7 +81,7 @@ export default class Sidebar extends React.PureComponent {<li key={index}><SidebarRootLinkisSingleRoot={length(this.props.nav) < 2}- title={capitalize(startCase(item.section))}+ title={capitalize(startCase(item.section)).replace(/^\d+ /, '')}isOpen={this.sectionIsOpen(item.section)}toggleSection={() =>this._toggleSection(item.section)diff --git a/guides/src/content/developer/tutorials/getting_started_tutorial.md b/guides/src/content/developer/1_getting_started/installation.mdsimilarity index 61%rename from guides/src/content/developer/tutorials/getting_started_tutorial.mdrename to guides/src/content/developer/1_getting_started/installation.mdindex b38222f907..c58bb75a95 100644--- a/guides/src/content/developer/tutorials/getting_started_tutorial.md+++ b/guides/src/content/developer/1_getting_started/installation.md@@ -1,14 +1,18 @@----title: Getting Started with Spree-section: tutorial+title: Installation+section: getting_startedorder: 0---## Prerequisites-Before starting this tutorial, make sure you have [Docker](https://docs.docker.com/get-docker/) installed on your system. This is fairly straightforward, but differs depending on which operating system you use.+Before proceeding make sure you have [Docker Desktop](https://docs.docker.com/get-docker/) installed on your system. This is fairly straightforward, but differs depending on which operating system you use.-If you would like to add Spree to your existing Ruby on Rails application, please [follow this guide instead](/developer/tutorials/existing_app_tutorial.html).+If you would like to add Spree to your existing Ruby on Rails application, please [follow this guide instead](/developer/advanced/existing_app_tutorial.html).++### Windows++Windows users will need to [install Linux subsystem](https://docs.microsoft.com/en-us/windows/wsl/install-win10) to proceed.## Installation@@ -16,6 +20,7 @@ If you would like to add Spree to your existing Ruby on Rails application, pleas2. Unzip it3. Rename `spree_starter-main` directory as you please4. Run `bin/setup` in said directory+5. Wait for the commands to execute (it can take around 2-3 minutes)## Hello, Spree Commerce@@ -39,13 +44,3 @@ Upon successful authentication, you should see the admin screen:Feel free to explore some of the Admin Panel features that Spree has to offer and to verify that your installation is working properly.--## Next steps--If you've followed the steps described in this tutorial, you should now have a fully functional Spree application up and running.--For starting/stopping/restarting application please refer to [Spree Starter README](https://github.com/spree/spree_starter#running-the-project).--We recommend you should also continue to [Customization section](/developer/customization/storefront.html) to learn how to modify and extend your Spree application.--To learn more about Spree internals please refer [Core section](/developer/core/orders.html).diff --git a/guides/src/content/developer/1_getting_started/understanding_spree.md b/guides/src/content/developer/1_getting_started/understanding_spree.mdnew file mode 100644index 0000000000..c7ea601f61--- /dev/null+++ b/guides/src/content/developer/1_getting_started/understanding_spree.md@@ -0,0 +1,68 @@+---+title: Understanding Spree+section: getting_started+order: 1+---++## How Spree works?++So you're probably wondering how all that magic works? Let's dive in.++## Rails Engine++Spree is a [Ruby on Rails Engine](https://guides.rubyonrails.org/engines.html), which means it's an application that provides functionality to their host applications (that is your store application).++Spree is a collection of Models, Views and Controllers that your application gains access when you install Spree. You can easily combine Spree with any Ruby on Rails application meaning you can add e-commerce capabilities to your existing RoR applications.++## Spree namespace++All Spree models, controllers and other classes are namespaced by the `Spree` keyword, eg. `Spree::Product`. This means that those files are also located in `spree` sub-directories eg. [app/models/spree/product.rb](https://github.com/spree/spree/blob/master/core/app/models/spree/product.rb).++## Spree modules++Spree is divided into several modules / gems which you can opt-out if you would like. Installing Spree via Spree Starter gives you access to all of Spree features such as Stoprefront, API and Admin Panel. Not all of the modules are required, eg. headless installations will not require Storefront at all.++Spree module | Description | Required?+--- | --- | ---+**api** | REST API for your Store | no*+**backend** | Admin Panel UI | no+**core** | Models, Services and libraries | yes+**frontend** | Storefront UI | no+**sample** | Sample seed data | no++<small>* yes, if you would like to use Storefront and/or Admin Panel</small>++--++There are many other Spree-gems providing additional functionality to your Store called [Extensions](/extensions).++To change which Spree gems you would like to install you will need to modify your project `Gemfile`.++### Full-stack Spree application++```ruby+gem 'spree'+```++### Headless installation with API and Admin Panel++```ruby+gem 'spree_api'+gem 'spree_backend'+```++After changing the Gemfile please run++```bash+bundle install+```++or if you're using Spree Starter:++```bash+bin/bundle-install+```++## Next steps++We recommend you go over [Internals section](/developer/internals) to learn more how Spree works under the hood. This knowledge will be very helpful when you'll decide you want to [customize your Spree store](/developer/customization/).diff --git a/guides/src/content/developer/core/addresses.md b/guides/src/content/developer/2_internals/addresses.mdsimilarity index 96%rename from guides/src/content/developer/core/addresses.mdrename to guides/src/content/developer/2_internals/addresses.mdindex f232dc4f6e..912f69fa21 100644--- a/guides/src/content/developer/core/addresses.md+++ b/guides/src/content/developer/2_internals/addresses.md@@ -1,6 +1,6 @@---title: "Addresses"-section: core+section: internals---## Address@@ -38,9 +38,9 @@ When an order's address is linked to a country or a state, that can ultimately aA zone is comprised of many different "zone members", which can either be a set of countries or a set of states.-Every order has a "tax zone", which indicates if a user should or shouldn't be taxed when placing an order. For more information, please see the [Taxation](/developer/core/taxation.html) guide.+Every order has a "tax zone", which indicates if a user should or shouldn't be taxed when placing an order. For more information, please see the [Taxation](/developer/internals/taxation.html) guide.-In addition to tax zones, orders also have shipping methods. These are provided to the user based on their address information, and once selected lock in how an order is going to be shipped to that user. For more information, please see the [Shipments](/developer/core/shipments.html) guide.+In addition to tax zones, orders also have shipping methods. These are provided to the user based on their address information, and once selected lock in how an order is going to be shipped to that user. For more information, please see the [Shipments](/developer/internals/shipments.html) guide.## Countriesdiff --git a/guides/src/content/developer/core/adjustments.md b/guides/src/content/developer/2_internals/adjustments.mdsimilarity index 96%rename from guides/src/content/developer/core/adjustments.mdrename to guides/src/content/developer/2_internals/adjustments.mdindex 31095df5b1..ba2a1b7321 100644--- a/guides/src/content/developer/core/adjustments.md+++ b/guides/src/content/developer/2_internals/adjustments.md@@ -1,12 +1,12 @@---title: "Adjustments"-section: core+section: internalsorder: 6---## Overview-An `Adjustment` object tracks an adjustment to the price of an [Order](/developer/core/orders.html), an order's [Line Item](/developer/core/orders.html#line-items), or an order's [Shipments](/developer/core/shipments.html) within a Spree Commerce storefront.+An `Adjustment` object tracks an adjustment to the price of an [Order](/developer/internals/orders.html), an order's [Line Item](/developer/internals/orders.html#line-items), or an order's [Shipments](/developer/internals/shipments.html) within a Spree Commerce storefront.Adjustments can be either positive or negative. Adjustments with a positive value are sometimes referred to as "charges" while adjustments with a negative value are sometimes referred to as "credits." These are just terms of convenience since there is only one `Spree::Adjustment` model in a storefront which handles this by allowing either positive or negative values.diff --git a/guides/src/content/developer/core/calculators.md b/guides/src/content/developer/2_internals/calculators.mdsimilarity index 99%rename from guides/src/content/developer/core/calculators.mdrename to guides/src/content/developer/2_internals/calculators.mdindex d0fd490e50..4edbf65817 100644--- a/guides/src/content/developer/core/calculators.md+++ b/guides/src/content/developer/2_internals/calculators.md@@ -1,6 +1,6 @@---title: 'Calculators'-section: core+section: internalsorder: 7---@@ -26,7 +26,7 @@ The following are descriptions of the currently available calculators in Spree.### Default Tax-For information about this calculator, please read the [Taxation](/developer/core/taxation.html) guide.+For information about this calculator, please read the [Taxation](/developer/internals/taxation.html) guide.### Flat Percent Per Item Totaldiff --git a/guides/src/content/developer/core/index.md b/guides/src/content/developer/2_internals/index.mdsimilarity index 88%rename from guides/src/content/developer/core/index.mdrename to guides/src/content/developer/2_internals/index.mdindex 4a2a56eb64..5daad5702f 100644--- a/guides/src/content/developer/core/index.md+++ b/guides/src/content/developer/2_internals/index.md@@ -1,6 +1,6 @@----title: "Core Internals"-section: core+title: "Spree Internals"+section: internals---This section covers all of the most important Spree internals. Nitty-gritty technical descriptions of how Spree works under the hood.diff --git a/guides/src/content/developer/core/inventory.md b/guides/src/content/developer/2_internals/inventory.mdsimilarity index 99%rename from guides/src/content/developer/core/inventory.mdrename to guides/src/content/developer/2_internals/inventory.mdindex 83de29c0a3..1ad9722d1d 100644--- a/guides/src/content/developer/core/inventory.md+++ b/guides/src/content/developer/2_internals/inventory.md@@ -1,6 +1,6 @@---title: "Inventory"-section: core+section: internalsorder: 5---diff --git a/guides/src/content/developer/core/orders.md b/guides/src/content/developer/2_internals/orders.mdsimilarity index 93%rename from guides/src/content/developer/core/orders.mdrename to guides/src/content/developer/2_internals/orders.mdindex 90a4b06838..d3e2a04581 100644--- a/guides/src/content/developer/core/orders.md+++ b/guides/src/content/developer/2_internals/orders.md@@ -1,6 +1,6 @@---title: "Orders"-section: core+section: internalsorder: 1---@@ -77,7 +77,7 @@ Assuming that an order meets the criteria for the next state, you will be able tAlongside the global Order state there's also `shipment_state` column which indicates the state of all shipments. Order can have multiple shipments.* `shipped` - all Shipments are in the `shipped` state-* `partial` - at least one Shipment has a state of `shipped` and there is another Shipment with a state other than `shipped` or there are [InventoryUnits](/developer/core/inventory.html) associated with the order that have a state of `sold` but are not associated with a Shipment+* `partial` - at least one Shipment has a state of `shipped` and there is another Shipment with a state other than `shipped` or there are [InventoryUnits](/developer/internals/inventory.html) associated with the order that have a state of `sold` but are not associated with a Shipment* `ready` - all Shipments are in the `ready` state* `backorder` - there is backordered inventory associated with an order* `pending` - all Shipments are in the `pending` state@@ -94,7 +94,7 @@ Alongside the global Order state there's also `payment_state` column which indic* `failed` - most recent payment is in the `failed` state* `void` - order is canceled and `payment_total` isequal to `zero`-For more on this please go to [Payment States page](/developer/core/payments.html#overview).+For more on this please go to [Payment States page](/developer/internals/payments.html#overview).### Order Shipment states@@ -110,17 +110,17 @@ An order can link to two `Address` objects. The shipping address indicates whereThe billing address indicates where the user who's paying for the order is located. This can alter the tax rate for the order, which in turn can change how much the final order total can be.-For more information about addresses, please read the [Addresses](/developer/core/addresses.html) guide.+For more information about addresses, please read the [Addresses](/developer/internals/addresses.html) guide.## Adjustments-Adjustments are used to affect an order's final cost, either by decreasing it ([Promotions](/developer/core/promotions.html)) or by increasing it ([Shipping](/developer/core/shipments.html), [Taxes](/developer/core/taxation.html)).+Adjustments are used to affect an order's final cost, either by decreasing it ([Promotions](/developer/internals/promotions.html)) or by increasing it ([Shipping](/developer/internals/shipments.html), [Taxes](/developer/internals/taxation.html)).-For more information about adjustments, please see the [Adjustments](/developer/core/adjustments.html) guide.+For more information about adjustments, please see the [Adjustments](/developer/internals/adjustments.html) guide.## Payments-Payment records are used to track payment information about an order. For more information, please read the [Payments](/developer/core/payments.html) guide.+Payment records are used to track payment information about an order. For more information, please read the [Payments](/developer/internals/payments.html) guide.## Return Authorizationsdiff --git a/guides/src/content/developer/core/payments.md b/guides/src/content/developer/2_internals/payments.mdsimilarity index 98%rename from guides/src/content/developer/core/payments.mdrename to guides/src/content/developer/2_internals/payments.mdindex 1ea0df14f7..5eb0ddc3e4 100644--- a/guides/src/content/developer/core/payments.md+++ b/guides/src/content/developer/2_internals/payments.md@@ -1,6 +1,6 @@---title: "Payments"-section: core+section: internalsorder: 3---@@ -10,7 +10,7 @@ Spree has a highly flexible payments model which allows multiple payment methodsPayment methods typically represent a payment gateway. Gateways will process card payments, and may also include non-gateway methods of payment such as Check, which is provided in Spree by default.-The `Payment` model in Spree tracks payments against [Orders](/developer/core/orders.html). Payments relate to a `source` which indicates how the payment was made, and a `PaymentMethod`, indicating the processor used for this payment.+The `Payment` model in Spree tracks payments against [Orders](/developer/internals/orders.html). Payments relate to a `source` which indicates how the payment was made, and a `PaymentMethod`, indicating the processor used for this payment.When a payment is created, it is given a unique, 8-character identifier. This is used when sending the payment details to the payment processor. Without this identifier, some payment gateways mistakenly reported duplicate payments.diff --git a/guides/src/content/developer/core/preferences.md b/guides/src/content/developer/2_internals/preferences.mdsimilarity index 99%rename from guides/src/content/developer/core/preferences.mdrename to guides/src/content/developer/2_internals/preferences.mdindex b325a4d07e..ebdc8a69bb 100644--- a/guides/src/content/developer/core/preferences.md+++ b/guides/src/content/developer/2_internals/preferences.md@@ -1,6 +1,6 @@---title: "Preferences"-section: core+section: internals---## Overview@@ -286,7 +286,7 @@ In the above configuration file, three preferences have been defined:It is recommended to create the configuration file in the `lib/` directory.***-Extensions can also define site-wide preferences. For more information on using preferences like this with extensions, check out the [Extensions Tutorial](/developer/tutorials/extensions_tutorial.html).+Extensions can also define site-wide preferences. For more information on using preferences like this with extensions, check out the [Extensions Tutorial](/developer/advanced/extensions_tutorial.html).***### Configuring Site-Wide Preferencesdiff --git a/guides/src/content/developer/core/products.md b/guides/src/content/developer/2_internals/products.mdsimilarity index 99%rename from guides/src/content/developer/core/products.mdrename to guides/src/content/developer/2_internals/products.mdindex b7d17a4c28..58c2e3671b 100644--- a/guides/src/content/developer/core/products.md+++ b/guides/src/content/developer/2_internals/products.md@@ -1,6 +1,6 @@---title: "Products"-section: core+section: internalsorder: 2---diff --git a/guides/src/content/developer/core/promotions.md b/guides/src/content/developer/2_internals/promotions.mdsimilarity index 98%rename from guides/src/content/developer/core/promotions.mdrename to guides/src/content/developer/2_internals/promotions.mdindex 1426d3534f..71a5e19f9b 100644--- a/guides/src/content/developer/core/promotions.md+++ b/guides/src/content/developer/2_internals/promotions.md@@ -1,6 +1,6 @@---title: "Promotions"-section: core+section: internalsorder: 5---@@ -41,7 +41,7 @@ When a `CreateAdjustment` action is undertaken, an adjustment is automatically aOnce the adjustment has been applied to the order, its eligibility is re-checked every time the order is saved, by way of the `Promotion#eligible?` method, which uses `Promotion#eligible_rules` to determine if the promotion is still eligible based on its rules. For how this process works, please see the [rules section](#rules) below.-An adjustment to an order from a promotion depends on the calculators. For more information about calculators, please see the [Calculators guide](/developer/core/calculators.html).+An adjustment to an order from a promotion depends on the calculators. For more information about calculators, please see the [Calculators guide](/developer/internals/calculators.html).### Creating an item adjustment@@ -49,7 +49,7 @@ When a `CreateItemAdjustments` action is undertaken, an adjustment is automaticaThe eligibility of the item for this promotion is re-checked whenever the item is updated. Its eligibility is based off the rules of the promotion.-An adjustment to an order from a promotion depends on the calculators. For more information about calculators, please see the [Calculators guide](/developer/core/calculators.html).+An adjustment to an order from a promotion depends on the calculators. For more information about calculators, please see the [Calculators guide](/developer/internals/calculators.html).### Free Shippingdiff --git a/guides/src/content/developer/core/shipments.md b/guides/src/content/developer/2_internals/shipments.mdsimilarity index 99%rename from guides/src/content/developer/core/shipments.mdrename to guides/src/content/developer/2_internals/shipments.mdindex 20cdb59375..ed71718882 100644--- a/guides/src/content/developer/core/shipments.md+++ b/guides/src/content/developer/2_internals/shipments.md@@ -142,7 +142,7 @@ Shipping methods can now have multiple shipping categories assigned to them. Thi### Zones-Zones serve as a mechanism for grouping geographic areas together into a single entity. You can read all about how to configure and use Zones in the [Zones Guide](/developer/core/addresses.html#zones).+Zones serve as a mechanism for grouping geographic areas together into a single entity. You can read all about how to configure and use Zones in the [Zones Guide](/developer/internals/addresses.html#zones).The Shipping Address entered during checkout will define the zone the customer is in and limit the Shipping Methods available to him.@@ -178,7 +178,7 @@ Spree ships with 5 default Calculators:Flexible rate is defined as a flat rate for the first product, plus a different flat rate for each additional product.-You can define your own calculator if you have more complex needs. In that case, check out the [Calculators Guide](/developer/core/calculators.html).+You can define your own calculator if you have more complex needs. In that case, check out the [Calculators Guide](/developer/internals/calculators.html).## UI@@ -208,7 +208,7 @@ There are a few Spree extensions which provide additional shipping methods, incl### Writing Your Own-For more detailed information, check out the section on [Calculators](/developer/core/calculators.html).+For more detailed information, check out the section on [Calculators](/developer/internals/calculators.html).Your calculator should accept an array of `LineItem` objects and return a cost. It can look at any reachable data, but typically uses the address, the order and the information from variants which are contained in the line_items.diff --git a/guides/src/content/developer/core/stores.md b/guides/src/content/developer/2_internals/stores.mdsimilarity index 76%rename from guides/src/content/developer/core/stores.mdrename to guides/src/content/developer/2_internals/stores.mdindex d621898791..e7bab4f534 100644--- a/guides/src/content/developer/core/stores.md+++ b/guides/src/content/developer/2_internals/stores.md@@ -1,6 +1,6 @@---title: "Stores"-section: core+section: internalsorder: 0---@@ -13,6 +13,7 @@ Each Store operates on a different domain or subdomain, eg.* Store B, `eu.example.com`* Store C, `another-brand.com`+## `current_store` methodAll Spree controllers or any other controllers that includes [Spree::Core::ControllerHelpers::Store](https://github.com/spree/spree/blob/master/core/lib/spree/core/controller_helpers/store.rb) have access to the `current_store` method which returns the currently in use `Spree::Store` object.@@ -30,9 +31,7 @@ To get the default store in code you can call `Spree::Store.default`.## Localization and Currency-<alert kind="note">- This section only applies to Spree 4.2 or newer. If you're using an older version, [please upgrade](/developer/upgrades)-</alert>+Each Store can have different multiple locales and currencies. This configuration is stored in Store model attributes:@@ -43,25 +42,21 @@ Each Store can have different multiple locales and currencies. This configuratio## Checkout configuration-<alert kind="note">- This section only applies to Spree 4.2 or newer. If you're using an older version, [please upgrade](/developer/upgrades)-</alert>-Each Store can be configured to ship to only selected countries. This is achieved via `checkout_zone_id` attribute which holds the ID of the selected [Zone record](/user/configuration/configuring_geography.html).-Available Shipping Methods on the Checkout are determined based on the [Zone and Shipping Methods configuration](/developer/core/shipments.html).+Available Shipping Methods on the Checkout are determined based on the [Zone and Shipping Methods configuration](/developer/internals/shipments.html).-This will also have an effect on what [Shipping / Billing Addresses](/developer/core/addresses.html) user can add / select during Checkout. Only Addresses from Countries or States available in the selected Zone can be used and will be visible in the User's Address Book.+This will also have an effect on what [Shipping / Billing Addresses](/developer/internals/addresses.html) user can add / select during Checkout. Only Addresses from Countries or States available in the selected Zone can be used and will be visible in the User's Address Book.## Associated models### Orders-When a user starts a checkout in a selected Store [Order](/developer/core/orders.html) is associated with that Store. That means that items added to the Cart will be visible only in a selected Store. If a user switches to another Store they will have a separate `Order` record for that Store. Order is created when a User adds the first item to the Cart. This means you can host multiple brands on one single Spree instance.+When a user starts a checkout in a selected Store [Order](/developer/internals/orders.html) is associated with that Store. That means that items added to the Cart will be visible only in a selected Store. If a user switches to another Store they will have a separate `Order` record for that Store. Order is created when a User adds the first item to the Cart. This means you can host multiple brands on one single Spree instance.### Payment Methods-Each [Payment Method](/developer/core/payments.html#payment-methods) can be associated with multiple Stores, eg. you would like to have Stripe and PayPal in Store A, but only Stripe in Store B, and Braintree in Store C.+Each [Payment Method](/developer/internals/payments.html#payment-methods) can be associated with multiple Stores, eg. you would like to have Stripe and PayPal in Store A, but only Stripe in Store B, and Braintree in Store C.### Productsdiff --git a/guides/src/content/developer/core/taxation.md b/guides/src/content/developer/2_internals/taxation.mdsimilarity index 95%rename from guides/src/content/developer/core/taxation.mdrename to guides/src/content/developer/2_internals/taxation.mdindex 25c0fd9c3c..42bd5f6a6e 100644--- a/guides/src/content/developer/core/taxation.md+++ b/guides/src/content/developer/2_internals/taxation.md@@ -1,6 +1,6 @@---title: Taxation-section: core+section: internalsorder: 6---@@ -10,7 +10,7 @@ Spree represents taxes for an order by using `tax_categories` and `tax_rates`.Products within Spree can be linked to Tax Categories, which are then used to influence the taxation rate for the products when they are purchased. One Tax Category can be set to being the default for the entire system, which means that if a product doesn't have a related tax category, then this default tax category would be used.-A `tax_category` can have many `tax_rates`, which indicate the rate at which the products belonging to a specific tax category will be taxed at. A tax rate links a tax rate to a particular zone (see [Addresses](/developer/core/addresses.html) for more information about zones). When an order is placed in a specific zone, any of the products for that order which have a tax zone that matches the order's tax zone will be taxed.+A `tax_category` can have many `tax_rates`, which indicate the rate at which the products belonging to a specific tax category will be taxed at. A tax rate links a tax rate to a particular zone (see [Addresses](/developer/internals/addresses.html) for more information about zones). When an order is placed in a specific zone, any of the products for that order which have a tax zone that matches the order's tax zone will be taxed.The standard sales tax policies commonly found in the USA can be modeled as well as Value Added Tax (VAT) which is commonly used in Europe. These are not the only types of tax rules that you can model in Spree. Once you obtain a sufficient understanding of the basic concepts you should be able to model the tax rules of your country or jurisdiction.@@ -43,7 +43,7 @@ Let's say you need to charge 5% tax for all items that ship to New York and 6% oHere's another hypothetical scenario. You would like to charge 10% tax on all electronic items and 5% tax on everything else. This tax should apply to all countries in the European Union (EU). In this case you would construct just a single zone consisting of all the countries in the EU. The fact that you want to charge two different rates depending on the type of good does not mean you need two zones.<alert kind="note">-Please see the [Addresses guide](/developer/core/addresses.html) for more information on constructing a zone.+Please see the [Addresses guide](/developer/internals/addresses.html) for more information on constructing a zone.</alert>## Default Tax Zone@@ -66,7 +66,7 @@ To determine tax based on billing address instead of shipping address you will n## Calculators-In order to charge tax in Spree you also need a `Spree::Calculator`. In most cases you should be able to use Spree's `DefaultTax` calculator. It is suitable for both sales tax and price-inclusive tax scenarios. For more information, please read the [Calculators guide](/developer/core/calculators.html).+In order to charge tax in Spree you also need a `Spree::Calculator`. In most cases you should be able to use Spree's `DefaultTax` calculator. It is suitable for both sales tax and price-inclusive tax scenarios. For more information, please read the [Calculators guide](/developer/internals/calculators.html).<alert kind="note">The `DefaultTax` calculator uses the item total (exclusive of shipping) when computing sales tax.@@ -93,7 +93,7 @@ If the customer purchases a single clothing item for $17.99 and they live in theThe sales tax calculation is $17.99 x 5% for a total tax of $0.8995, which is rounded up to two decimal places, to $0.90. This tax amount is then applied to the order as an adjustment.<alert kind="note">-See the [Adjustments Guide](/developer/core/adjustments.html) if you need more information on adjustments.+See the [Adjustments Guide](/developer/internals/adjustments.html) if you need more information on adjustments.</alert>If the quantity of the item is changed to 2, then the tax amount doubles: ($17.99 x 2) x 0.05 is $1.799, which is again rounded up to two decimal places, applying a tax adjustment of $1.80.diff --git a/guides/src/content/developer/customization/api_v1.md b/guides/src/content/developer/3_customization/api_v1.mdsimilarity index 89%rename from guides/src/content/developer/customization/api_v1.mdrename to guides/src/content/developer/3_customization/api_v1.mdindex b2e43a6bef..9fa22561c6 100644--- a/guides/src/content/developer/customization/api_v1.md+++ b/guides/src/content/developer/3_customization/api_v1.md@@ -10,11 +10,11 @@ order: 7## Introduction-In this tutorial we are going to learn how we can customize the **[REST API](../../api)** provided by Spree, adding a new endpoint (or you can override an existing in core). We will use `spree_simple_sales` extension created in [Extensions tutorial](/developer/tutorials/extensions_tutorial.html). If you haven't seen before, please check them!+In this tutorial we are going to learn how we can customize the **[REST API](../../api)** provided by Spree, adding a new endpoint (or you can override an existing in core). We will use `spree_simple_sales` extension created in [Extensions tutorial](/developer/advanced/extensions_tutorial.html). If you haven't seen before, please check them!## Adding Custom Endpoints-Similarly to adding a controller action of [Extensions tutorial](/developer/tutorials/extensions_tutorial.html), you can create a new controller class with an action that emits a json response from a [Rabl](https://github.com/nesquena/rabl) view.+Similarly to adding a controller action of [Extensions tutorial](/developer/advanced/extensions_tutorial.html), you can create a new controller class with an action that emits a json response from a [Rabl](https://github.com/nesquena/rabl) view.### Creating the controller and action@@ -99,7 +99,7 @@ attributes *product_attributes << :sale_price### Testing Our endpoint-Like described in [Testing Our Decorator](/developer/tutorials/extensions_tutorial.html#testing-our-decorator) it's always a good idea to test your code, including your api new/changed endpoints. Let's write a integration test that simulate your api of simple unit tests for `sales_controller.rb`+Like described in [Testing Our Decorator](/developer/advanced/extensions_tutorial.html#testing-our-decorator) it's always a good idea to test your code, including your api new/changed endpoints. Let's write a integration test that simulate your api of simple unit tests for `sales_controller.rb`#### Creating and running the test@@ -185,5 +185,5 @@ api_key = user.spree_api_key # Copy the api_key valueNow, when we head to `http://localhost:3000/api/v1/sales`, passing the header `X-Spree-Token: [YOUR_COPIED_API_KEY]`, (or add a `?token=[YOUR_COPIED_API_KEY]` to the url) into your browser or any REST client, we should see the json result with all products with a sale price.<alert kind="note">- Note that you will likely need to restart our example Spree application (created in the [Getting Started](/developer/tutorials/getting_started_tutorial.html) tutorial).+ Note that you will likely need to restart our example Spree application (created in the [Getting Started](/developer/getting_started/installation.html) tutorial).</alert>diff --git a/guides/src/content/developer/customization/api_v2.md b/guides/src/content/developer/3_customization/api_v2.mdsimilarity index 100%rename from guides/src/content/developer/customization/api_v2.mdrename to guides/src/content/developer/3_customization/api_v2.mddiff --git a/guides/src/content/developer/customization/asset.md b/guides/src/content/developer/3_customization/asset.mdsimilarity index 100%rename from guides/src/content/developer/customization/asset.mdrename to guides/src/content/developer/3_customization/asset.mddiff --git a/guides/src/content/developer/customization/authentication.md b/guides/src/content/developer/3_customization/authentication.mdsimilarity index 100%rename from guides/src/content/developer/customization/authentication.mdrename to guides/src/content/developer/3_customization/authentication.mddiff --git a/guides/src/content/developer/customization/checkout.md b/guides/src/content/developer/3_customization/checkout.mdsimilarity index 97%rename from guides/src/content/developer/customization/checkout.mdrename to guides/src/content/developer/3_customization/checkout.mdindex bbdfc6ce37..6d20d4bbdd 100644--- a/guides/src/content/developer/customization/checkout.md+++ b/guides/src/content/developer/3_customization/checkout.md@@ -43,7 +43,7 @@ def check_registrationend```-The configuration of the guest checkout option is done via [Preferences](/developer/core/preferences.html). Spree will allow guest checkout by default. Use the `allow_guest_checkout` preference to change the default setting.+The configuration of the guest checkout option is done via [Preferences](/developer/internals/preferences.html). Spree will allow guest checkout by default. Use the `allow_guest_checkout` preference to change the default setting.### Address Information@@ -59,7 +59,7 @@ The address fields include a select box for choosing state/province. The list ofThe state field can be disabled entirely by using the `Spree::Config[:address_requires_state]` preference. You can also allow for an "alternate phone" field by using the `Spree::Config[:alternative_shipping_phone]` and `Spree::Config[:alternative_shipping]` fields.</alert>-The list of countries that appear in the country select box can also be configured. Spree will list all countries by default, but you can configure exactly which countries you would like to appear. The list can be limited to a specific set of countries by configuring the `Spree::Config[:checkout_zone]` preference and setting its value to the name of a [Zone](/developer/core/addresses.html#zones) containing the countries you wish to use. Spree assumes that the list of billing and shipping countries will be the same. You can always change this logic via an extension if this does not suit your needs.+The list of countries that appear in the country select box can also be configured. Spree will list all countries by default, but you can configure exactly which countries you would like to appear. The list can be limited to a specific set of countries by configuring the `Spree::Config[:checkout_zone]` preference and setting its value to the name of a [Zone](/developer/internals/addresses.html#zones) containing the countries you wish to use. Spree assumes that the list of billing and shipping countries will be the same. You can always change this logic via an extension if this does not suit your needs.### Delivery Options@@ -81,7 +81,7 @@ If you do not want to use a gateway with payment profiles then you will need toinformation will be lost before it's time to authorize the card.</alert>-For more information about payments, please see the [Payments guide](/developer/core/payments.html).+For more information about payments, please see the [Payments guide](/developer/internals/payments.html).### Confirmationdiff --git a/guides/src/content/developer/customization/dependencies.md b/guides/src/content/developer/3_customization/dependencies.mdsimilarity index 100%rename from guides/src/content/developer/customization/dependencies.mdrename to guides/src/content/developer/3_customization/dependencies.mddiff --git a/guides/src/content/developer/customization/emails.md b/guides/src/content/developer/3_customization/emails.mdsimilarity index 100%rename from guides/src/content/developer/customization/emails.mdrename to guides/src/content/developer/3_customization/emails.mddiff --git a/guides/src/content/developer/customization/extensions.md b/guides/src/content/developer/3_customization/extensions.mdsimilarity index 84%rename from guides/src/content/developer/customization/extensions.mdrename to guides/src/content/developer/3_customization/extensions.mdindex 115e52ebdc..37d2264bb2 100644--- a/guides/src/content/developer/customization/extensions.md+++ b/guides/src/content/developer/3_customization/extensions.md@@ -36,8 +36,9 @@ Answer **yes** when prompted to run migrations.## Finding more Extensions-[Spree Contrib](https://github.com/spree-contrib) GitHub Organization is a collection of officially supported extensions. You can also find others on GitHub.+[Go to Extension Directory](/extensions/) to find more. You can also search and browse GitHub there are many smaller,+3rd party extensions out there.## Creating your own Extension-Please refer [Creating an Extension Tutorial](/developer/tutorials/extensions_tutorial.html)+Please refer [Creating an Extension Tutorial](/developer/advanced/extensions_tutorial.html)diff --git a/guides/src/content/developer/customization/i18n.md b/guides/src/content/developer/3_customization/i18n.mdsimilarity index 100%rename from guides/src/content/developer/customization/i18n.mdrename to guides/src/content/developer/3_customization/i18n.mddiff --git a/guides/src/content/developer/customization/images.md b/guides/src/content/developer/3_customization/images.mdsimilarity index 100%rename from guides/src/content/developer/customization/images.mdrename to guides/src/content/developer/3_customization/images.mddiff --git a/guides/src/content/developer/customization/logic.md b/guides/src/content/developer/3_customization/logic.mdsimilarity index 100%rename from guides/src/content/developer/customization/logic.mdrename to guides/src/content/developer/3_customization/logic.mddiff --git a/guides/src/content/developer/customization/permissions.md b/guides/src/content/developer/3_customization/permissions.mdsimilarity index 100%rename from guides/src/content/developer/customization/permissions.mdrename to guides/src/content/developer/3_customization/permissions.mddiff --git a/guides/src/content/developer/customization/storefront.md b/guides/src/content/developer/3_customization/storefront.mdsimilarity index 98%rename from guides/src/content/developer/customization/storefront.mdrename to guides/src/content/developer/3_customization/storefront.mdindex 2227d86570..052414cb6e 100644--- a/guides/src/content/developer/customization/storefront.md+++ b/guides/src/content/developer/3_customization/storefront.md@@ -4,11 +4,6 @@ section: customizationorder: 0----<alert kind="note">- The default Storefront mentioned in this guide is available since [Spree 4.1 release](/release_notes/4_1_0.html). If you're using- an older Spree version [please upgrade](/developer/upgrades/four-dot-oh-to-four-dot-one.html).-</alert>-## Styling with SASS variablesSpree 4 under the hood uses [Bootstrap 4](https://getbootstrap.com/docs/4.6/getting-started/theming/) for easy theming with some additional Spree-specific [SASS variables](https://sass-lang.com/documentation/variables).diff --git a/guides/src/content/developer/customization/view.md b/guides/src/content/developer/3_customization/view.mdsimilarity index 96%rename from guides/src/content/developer/customization/view.mdrename to guides/src/content/developer/3_customization/view.mdindex 5bda4c4e16..9cb6dd3686 100644--- a/guides/src/content/developer/customization/view.md+++ b/guides/src/content/developer/3_customization/view.md@@ -35,7 +35,7 @@ All of those views will be added to your `app/views` directory under `spree` fol### Switch storefront layout-If you want to leave most of the views intact and you want to only change the layout file you can change it by setting a [preference](/developer/core/preferences.html) in your Spree initializer (`config/initializers/spree.rb`), eg.+If you want to leave most of the views intact and you want to only change the layout file you can change it by setting a [preference](/developer/internals/preferences.html) in your Spree initializer (`config/initializers/spree.rb`), eg.```rubySpree.config do |config|diff --git a/guides/src/content/developer/tutorials/deface_overrides_tutorial.md b/guides/src/content/developer/4_advanced/deface_overrides_tutorial.mdsimilarity index 97%rename from guides/src/content/developer/tutorials/deface_overrides_tutorial.mdrename to guides/src/content/developer/4_advanced/deface_overrides_tutorial.mdindex 7ccab3bee7..b7ffc22f92 100644--- a/guides/src/content/developer/tutorials/deface_overrides_tutorial.md+++ b/guides/src/content/developer/4_advanced/deface_overrides_tutorial.md@@ -1,6 +1,6 @@---title: Deface Overrides-section: tutorial+section: advanced---<alert kind="warning">@@ -9,7 +9,7 @@ section: tutorial## Introduction-This tutorial is a continuation of the previous one, [Extensions](/developer/tutorials/extensions_tutorial.html), and begins where we left off in the last one. We have created a simple extension for promoting on-sale products on a "sales homepage".+This tutorial is a continuation of the previous one, [Extensions](/developer/advanced/extensions_tutorial.html), and begins where we left off in the last one. We have created a simple extension for promoting on-sale products on a "sales homepage".In this tutorial we are going to learn about [Deface](https://github.com/spree/deface) and how we can use it to improve our extension. As part of improving our extension, we will be updating the existing Spree admin interface so that we are able to set the `sale_price` for products.@@ -79,7 +79,7 @@ module Spreeend```-Now, when we head to `http://localhost:3000/admin/products` and edit a product, we should be able to set a sale price for the product and be able to view it on our sale page, `http://localhost:3000/sale`. Note that you will likely need to restart our example Spree application (created in the [Getting Started](/developer/tutorials/getting_started_tutorial.html) tutorial).+Now, when we head to `http://localhost:3000/admin/products` and edit a product, we should be able to set a sale price for the product and be able to view it on our sale page, `http://localhost:3000/sale`. Note that you will likely need to restart our example Spree application (created in the [Getting Started tutorial](/developer/getting_started/installation.html)).### Available actionsdiff --git a/guides/src/content/developer/tutorials/existing_app_tutorial.md b/guides/src/content/developer/4_advanced/existing_app_tutorial.mdsimilarity index 98%rename from guides/src/content/developer/tutorials/existing_app_tutorial.mdrename to guides/src/content/developer/4_advanced/existing_app_tutorial.mdindex 0d9a0f1da6..687c89923d 100644--- a/guides/src/content/developer/tutorials/existing_app_tutorial.md+++ b/guides/src/content/developer/4_advanced/existing_app_tutorial.md@@ -1,6 +1,6 @@---title: Add Spree to an existing Ruby on Rails application-section: tutorial+section: advancedorder: 1---@@ -21,7 +21,7 @@ in your project root directory.**Rails 6.0 and 6.1**```ruby- gem 'spree', '~> 4.2.0'+ gem 'spree', '~> 4.2'gem 'spree_auth_devise', '~> 4.3'gem 'spree_gateway', '~> 3.9'gem 'spree_i18n', '~> 5.0'@@ -146,4 +146,4 @@ If you've followed the steps described in this tutorial, you should now have a fWe recommend you should continue to [Customization section](/developer/customization/storefront.html) to learn how to modify and extend your Spree application.-To learn more about Spree internals please refer [Core section](/developer/core/orders.html).+To learn more about Spree internals please refer [Core section](/developer/internals/orders.html).diff --git a/guides/src/content/developer/tutorials/extend_product_attributes.md b/guides/src/content/developer/4_advanced/extend_product_attributes.mdsimilarity index 100%rename from guides/src/content/developer/tutorials/extend_product_attributes.mdrename to guides/src/content/developer/4_advanced/extend_product_attributes.mddiff --git a/guides/src/content/developer/tutorials/migration.md b/guides/src/content/developer/4_advanced/migration.mdsimilarity index 98%rename from guides/src/content/developer/tutorials/migration.mdrename to guides/src/content/developer/4_advanced/migration.mdindex 90df8a35ad..723dc64255 100644--- a/guides/src/content/developer/tutorials/migration.md+++ b/guides/src/content/developer/4_advanced/migration.md@@ -216,12 +216,12 @@ this if the product does not have option variants.If you don't have option variants, then you may also need to registersome stock for the master variant. The exact steps depend on how you-have configured Spree's [inventory system](/developer/core/inventory.html), but most sites+have configured Spree's [inventory system](/developer/internals/inventory.html), but most siteswill just need to assign to *p.on_hand*, eg *p.on_hand = 100*.#### Shipping category-A product's [shipping category](/developer/core/shipments.html#shipping-categories) field+A product's [shipping category](/developer/internals/shipments.html#shipping-categories) fieldprovides product-specific information for the shippingcalculators, eg to indicate that a product requires additional insuranceor can only be surface shipped. If no special conditions are needed, you@@ -244,7 +244,7 @@ The model wraps a name *and* a description (both strings), and you canleave the field as nil if no special treatment is needed.You can use the *where.first_or_create* technique, though you probably-want to set up the entire [tax configuration](/developer/core/taxation.html) before you start+want to set up the entire [tax configuration](/developer/internals/taxation.html) before you startloading products.You can also fill in this information automatically at a *later* date,@@ -379,7 +379,7 @@ a product's price will need to be copied to all of its variants.Next, you may also want to register some stock for this variant.The exact steps depend on how you have configured Spree's-[inventory system](/developer/core/inventory.html), but most sites+[inventory system](/developer/internals/inventory.html), but most siteswill just need to assign to *v.on_hand*, eg *v.on_hand = 100*.You now need to set some option types and values, so customers candiff --git a/guides/src/content/developer/tutorials/seo.md b/guides/src/content/developer/4_advanced/seo.mdsimilarity index 100%rename from guides/src/content/developer/tutorials/seo.mdrename to guides/src/content/developer/4_advanced/seo.mddiff --git a/guides/src/content/developer/tutorials/testing.md b/guides/src/content/developer/4_advanced/testing.mdsimilarity index 100%rename from guides/src/content/developer/tutorials/testing.mdrename to guides/src/content/developer/4_advanced/testing.mddiff --git a/guides/src/content/developer/security/api.md b/guides/src/content/developer/6_security/api.mdsimilarity index 100%rename from guides/src/content/developer/security/api.mdrename to guides/src/content/developer/6_security/api.mddiff --git a/guides/src/content/developer/security/authentication_and_authorization.md b/guides/src/content/developer/6_security/authentication_and_authorization.mdsimilarity index 100%rename from guides/src/content/developer/security/authentication_and_authorization.mdrename to guides/src/content/developer/6_security/authentication_and_authorization.mddiff --git a/guides/src/content/developer/security/security.md b/guides/src/content/developer/6_security/index.mdsimilarity index 100%rename from guides/src/content/developer/security/security.mdrename to guides/src/content/developer/6_security/index.mddiff --git a/guides/src/content/developer/security/pci_compliance.md b/guides/src/content/developer/6_security/pci_compliance.mdsimilarity index 100%rename from guides/src/content/developer/security/pci_compliance.mdrename to guides/src/content/developer/6_security/pci_compliance.mddiff --git a/guides/src/content/developer/index.md b/guides/src/content/developer/index.mdindex 7b41966d17..485074d5c1 100644--- a/guides/src/content/developer/index.md+++ b/guides/src/content/developer/index.md@@ -1,9 +1,21 @@----title: Spree Developer Documentation+title: Developer Documentation----This part of Spree's documentation covers the technical aspects of Spree. If you are working with Rails and are building a Spree store, this is the documentation for you.+This part of Spree's documentation covers the technical aspects of Spree. If you're building a Spree store, this is the documentation for you.-**The best place to start is the [Getting Started guide](/developer/tutorials/getting_started_tutorial.html).**+## Where to start?-Otherwise, please see the [user documentation](/user/).+The best place to start is the [Getting Started guide](/developer/getting_started/installation.html).++## I want to learn how Spree works++This wisdom can be found reading [Internals section](/developer/internals/).++## I want to customize my Spree Store++You will find all the required information in the [Customization section](/developer/customization/storefront.html).++## I want to contribute to Spree++Awesome! Please see [Contributing](developer/contributing/) for details.diff --git a/guides/src/content/developer/upgrades/four-dot-one-to-four-dot-two.md b/guides/src/content/developer/upgrades/four-dot-one-to-four-dot-two.mdindex 887f1b36ed..48a5b6e6e8 100644--- a/guides/src/content/developer/upgrades/four-dot-one-to-four-dot-two.md+++ b/guides/src/content/developer/upgrades/four-dot-one-to-four-dot-two.md@@ -39,7 +39,7 @@ If you used that gem in the past you need to remove. Multi Currency is now incor## Add `deface` gem (optional)-If you use [Deface overrides](/developer/tutorials/deface_overrides_tutorial.html) you will need to include `deface` in your `Gemfile` as it was removed from Spree / Spree Auth Devise / Spree Gateway dependencies.+If you used [Deface overrides](/developer/advanced/deface_overrides_tutorial.html) you will need to include `deface` in your `Gemfile` as it was removed from Spree / Spree Auth Devise / Spree Gateway dependencies.Simply add it to your `Gemfile`:diff --git a/guides/src/content/user/configuration/configuring_inventory.md b/guides/src/content/user/configuration/configuring_inventory.mdindex 950c43b264..cf6162a58e 100644--- a/guides/src/content/user/configuration/configuring_inventory.md+++ b/guides/src/content/user/configuration/configuring_inventory.md@@ -7,11 +7,11 @@ order: 1The Spree store gives you a great deal of leverage in managing your business' inventory. You can set up multiple [stock locations](#stock-locations), each of which represents a physical location where you store your products for delivery to customers. As you add new products and make sales, [stock movements](#stock-movements) are recorded. You can receive stock from a supplier, and even move products from one stock location to another by recording [stock transfers](#stock-transfers). All of this helps to keep your inventorying manageable and current.-### Stock Locations+## Stock LocationsTo reach the Stock Locations management panel, go to your Admin Interface, click "Configuration", then click "Stock Locations". Your store should already have at least one default stock location. If you keep all of your inventory in one place, this may be all you need.-#### Creating a New Stock Location+### Creating a New Stock LocationTo add a stock location to your store, click the "New Stock Location" button.@@ -25,7 +25,7 @@ Here, you can input everything of relevance about your stock location: name, addInput the values for all of the fields, and click "Create" to add your new stock location.-#### Editing a Stock Location+### Editing a Stock LocationTo edit a stock location, click the "Edit" icon next to it in the Stock Locations list.@@ -33,7 +33,7 @@ To edit a stock location, click the "Edit" icon next to it in the Stock LocationMake the desired changes in the form and click "Update".-#### Deleting a Stock Location+### Deleting a Stock LocationTo remove a stock location, click the "Delete" icon next to it in the Stock Locations list.@@ -41,7 +41,7 @@ To remove a stock location, click the "Delete" icon next to it in the Stock LocaClick "OK" to confirm the deletion.-### Stock Movements+## Stock MovementsNote the "Stock Movements" link on the Stock Locations list.@@ -51,7 +51,7 @@ Clicking this link will show you all of the stock movements that have taken placStock movements are actions that happen automatically through the normal management and functioning of your store. You do not have to (and in fact, can not) manually manipulate them. This is just a way for you to see which things are moving in and out of a particular stock location.-### Stock Transfers+## Stock TransfersIf you have more than one stock location, your Spree store offers you a way to record the movement of inventory from one location to another: the stock transfer.@@ -67,9 +67,9 @@ Select a product variant from the "Variant" drop-down list and enter the quantit-***+<alert kind="warning">If you try to transfer an item that you do not have in stock at your Source location, the Spree system will record a stock transfer with a quantity of 0.-***+</alert>The new stock transfer is readied. Once you have added all of the items you want to transfer, click the "Transfer Stock" button.diff --git a/guides/src/content/user/index.md b/guides/src/content/user/index.mdindex d3d8094a82..557d58bdd0 100644--- a/guides/src/content/user/index.md+++ b/guides/src/content/user/index.md@@ -1,5 +1,5 @@----title: Spree User Documentation+title: User Documentation---Welcome to the Spree User Guides! This documentation is intended for business owners and site administrators of Spree e-commerce sites. Everything you need to know to configure and manage your Spree store can be found here.diff --git a/guides/src/content/user/orders/entering_orders.md b/guides/src/content/user/orders/entering_orders.mdindex 47dabe6168..29453921f3 100644--- a/guides/src/content/user/orders/entering_orders.md+++ b/guides/src/content/user/orders/entering_orders.md@@ -97,7 +97,7 @@ You need only enter the "Amount" (positive for a charge on the order; negative f-For a better understanding of adjustments, please read the [Developer Adjustments Guide](/developer/core/adjustments.html).+For a better understanding of adjustments, please read the [Developer Adjustments Guide](/developer/internals/adjustments.html).Once you have finished all of the changes you want in the order's Adjustments, click "Continue".diff --git a/guides/src/content/user/payments/payment_states.md b/guides/src/content/user/payments/payment_states.mdindex 85f9908788..d40814a090 100644--- a/guides/src/content/user/payments/payment_states.md+++ b/guides/src/content/user/payments/payment_states.md@@ -33,7 +33,7 @@ The details for the payment will appear. The "Payment State" column will displayAuthorizing a payment is the process of confirming the availability of funds for a transaction with the purchaser's credit card company. Capturing a payment is the process of telling the credit card company that you would like to get paid for the transaction amount. Typically, this two-step process of first authorizing the payment and then capturing the payment is used by online retailers to delay charging the customer until the product(s) purchased have been fulfilled (shipped).-By default, Spree automatically handles authorizing the payment for a transaction. For capturing payments, we give you the choice of auto-capturing the payment or manually capturing the payment via the Admin Interface. If you like, you can read further [documentation about auto-capturing payments](/developer/core/payments.html#auto-capturing).+By default, Spree automatically handles authorizing the payment for a transaction. For capturing payments, we give you the choice of auto-capturing the payment or manually capturing the payment via the Admin Interface. If you like, you can read further [documentation about auto-capturing payments](/developer/internals/payments.html#auto-capturing).Note: Not all payment gateways allow for the two-step *authorize and then capture* payment process. If this functionality is required for your store, please confirm with your payment gateway that they can support this process.diff --git a/guides/src/content/user/shipments/calculators.md b/guides/src/content/user/shipments/calculators.mdindex 2e2b2ce16b..ff32c1993f 100644--- a/guides/src/content/user/shipments/calculators.md+++ b/guides/src/content/user/shipments/calculators.md@@ -69,7 +69,7 @@ A customer whose order subtotal equals $35 would be offered a shipping cost of $### Custom Calculators-You can define your own calculator if you have more complex needs. In that case, check out the [Calculators Guide](/developer/core/calculators.html).+You can define your own calculator if you have more complex needs. In that case, check out the [Calculators Guide](/developer/internals/calculators.html).## Next Stepdiff --git a/guides/src/templates/guide.js b/guides/src/templates/guide.jsindex 9aea145b5d..cbacfafe6f 100644--- a/guides/src/templates/guide.js+++ b/guides/src/templates/guide.js@@ -59,11 +59,11 @@ export default function Template({ data }) {let pageTitle = guide.frontmatter.title- if (guide.fields.section) {- pageTitle += ` | ${capitalize(guide.fields.section.replace(/_/, ' '))}`+ if (guide.fields.section && guide.fields.section !== guide.fields.rootSection) {+ pageTitle += ` | ${capitalize(guide.fields.section.replace('_', ' ').replace(/^\d+/, ''))}`}- if (guide.fields.rootSection) {- pageTitle += ` | ${capitalize(guide.fields.rootSection.replace(/_/, ' '))}`+ if (guide.fields.rootSection && guide.fields.rootSection !== pageTitle) {+ pageTitle += ` | ${capitalize(guide.fields.rootSection.replace('_', ' '))}`}let pageDescription = guide.frontmatter.descriptiondiff --git a/netlify.toml b/netlify.tomlindex e859b5f8c8..6313bc9a5a 100644--- a/netlify.toml+++ b/netlify.toml@@ -60,7 +60,11 @@ ID = "49ded9cc-27d3-4e02-b186-4fd7fd334ed8"# tutorials redirects[[redirects]]from = "/developer/getting_started_tutorial.html"- to = "/developer/tutorials/getting_started_tutorial.html"+ to = "/developer/getting_started/installation.html"++[[redirects]]+ from = "/developer/tutorials/getting_started_tutorial.html"+ to = "/developer/getting_started/installation.html"[[redirects]]from = "/developer/api_customization_tutorial.html"@@ -68,72 +72,92 @@ ID = "49ded9cc-27d3-4e02-b186-4fd7fd334ed8"[[redirects]]from = "/developer/deface_overrides_tutorial.html"- to = "/developer/tutorials/deface_overrides_tutorial.html"+ to = "/developer/advanced/deface_overrides_tutorial.html"++[[redirects]]+ from = "/developer/tutorials/deface_overrides_tutorial.html"+ to = "/developer/advanced/deface_overrides_tutorial.html"[[redirects]]from = "/developer/extensions_tutorial.html"- to = "/developer/tutorials/extensions_tutorial.html"+ to = "/developer/contributing/extensions_tutorial.html"++[[redirects]]+ from = "/developer/tutorials/extensions_tutorial.html"+ to = "/developer/contributing/extensions_tutorial.html"[[redirects]]from = "/developer/testing.html"- to = "/developer/tutorials/testing.html"+ to = "/developer/advanced/testing.html"++[[redirects]]+ from = "/developer/tutorials/testing.html"+ to = "/developer/advanced/testing.html"[[redirects]]from = "/developer/migration.html"- to = "/developer/tutorials/migration.html"+ to = "/developer/advanced/migration.html"[[redirects]]from = "/developer/seo.html"- to = "/developer/tutorials/seo.html"+ to = "/developer/advanced/seo.html"++[[redirects]]+ from = "/developer/tutorials/seo.html"+ to = "/developer/advanced/seo.html"[[redirects]]from = "/developer/security.html"- to = "/developer/tutorials/security.html"+ to = "/developer/security"++[[redirects]]+ from = "/developer/tutorials/security.html"+ to = "/developer/security"# core[[redirects]]from = "/developer/addresses.html"- to = "/developer/core/addresses.html"+ to = "/developer/internals/addresses.html"[[redirects]]from = "/developer/adjustments.html"- to = "/developer/core/adjustments.html"+ to = "/developer/internals/adjustments.html"[[redirects]]from = "/developer/calculators.html"- to = "/developer/core/calculators.html"+ to = "/developer/internals/calculators.html"[[redirects]]from = "/developer/inventory.html"- to = "/developer/core/inventory.html"+ to = "/developer/internals/inventory.html"[[redirects]]from = "/developer/orders.html"- to = "/developer/core/orders.html"+ to = "/developer/internals/orders.html"[[redirects]]from = "/developer/payments.html"- to = "/developer/core/payments.html"+ to = "/developer/internals/payments.html"[[redirects]]from = "/developer/preferences.html"- to = "/developer/core/preferences.html"+ to = "/developer/internals/preferences.html"[[redirects]]from = "/developer/products.html"- to = "/developer/core/products.html"+ to = "/developer/internals/products.html"[[redirects]]from = "/developer/promotions.html"- to = "/developer/core/promotions.html"+ to = "/developer/internals/promotions.html"[[redirects]]from = "/developer/shipments.html"- to = "/developer/core/shipments.html"+ to = "/developer/internals/shipments.html"[[redirects]]from = "/developer/taxation.html"- to = "/developer/core/taxation.html"+ to = "/developer/internals/taxation.html"# customization@@ -305,4 +329,12 @@ ID = "49ded9cc-27d3-4e02-b186-4fd7fd334ed8"[[redirects]]from = "/api/overview"- to = "https://api.spreecommerce.org"+ to = "/api/"++# core -> internals redirects+[[redirects]]+ from = "/developer/core/"+ to = "/developer/internals/"+[[redirects]]+ from = "/developer/core/*"+ to = "/developer/internals/:splat"