Skip to content

armgit / spree

Public Imported from GitHub
0

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.

[skip ci] updated to upgrade guides

Damian Legawieca39ed2b69f1f
diff --git a/docs/api-reference/introduction.mdx b/docs/api-reference/introduction.mdx
index 005309dac2..8f286be85d 100644
--- a/docs/api-reference/introduction.mdx
+++ b/docs/api-reference/introduction.mdx
@@ -1,8 +1,8 @@
Spree comes with a fully-featured API that allows it to operate in a fully headless mode. This means that you can use Spree as a backend and build your custom storefront, mobile app, or any other application that needs to interact with an e-commerce platform.
-## APIs
+## API v2
-Currently Spree includes 2 APIs:
+Currently Spree includes 2 modern REST APIs:
<CardGroup cols={2}>
<Card title="Storefront API" href="storefront">
@@ -13,6 +13,6 @@ Currently Spree includes 2 APIs:
</Card>
</CardGroup>
-### Legacy REST API v1
+## Legacy REST API v1
Legacy REST API v1 was extracted to `spree_api_v1` gem. It is not recommended to use it in new projects, but it's still available for existing ones.
diff --git a/docs/developer/upgrades/4.3-to-4.4.mdx b/docs/developer/upgrades/4.3-to-4.4.mdx
index a2fd340a5f..8387c5f636 100644
--- a/docs/developer/upgrades/4.3-to-4.4.mdx
+++ b/docs/developer/upgrades/4.3-to-4.4.mdx
@@ -57,21 +57,7 @@ bin/rake railties:install:migrations
bin/rails db:migrate
```
-## Update Spree Dashboard (`spree_backend`)
-
-### Update Gemfile
-
-```ruby
-gem 'spree_backend', '~> 4.4'
-```
-
-### Update gems
-
-```shell
-bundle update
-```
-
-### Run install generators
+## Run install generators
This will copy some files from `spree_backend` to your application.
@@ -85,12 +71,12 @@ If you're using `spree_frontend` you need to run the frontend install generator
bin/rails g spree:frontend:install
```
+## Additional fixes and hints
+
### Make sure that Node is available in your cloud environment
On Heroku, you need to add the node buildpack - [https://devcenter.heroku.com/articles/buildpacks#using-multiple-buildpacks](https://devcenter.heroku.com/articles/buildpacks#using-multiple-buildpacks)
-## Additional fixes and hints
-
### Add Spree ActiveJob queues to your Sidekiq config
Spree uses ActiveJob for processing long running operations to not interrupt your web server performance.
@@ -118,10 +104,6 @@ end
Webhooks do not fire on touch events. Webhooks also do not do anything until there is a first webhook subscriber created which can be done in the Admin Dashboard or via Platform API.
-### Update Spree SDK
-
-To use the new features such as Wishlists and Digital Products in your storefront please update [Spree SDK](https://github.com/spree/spree-storefront-api-v2-js-sdk) to [v4.12](https://github.com/spree/spree-storefront-api-v2-js-sdk/releases/tag/v4.12.0) at least.
-
### Update Spree Dependencies that was renamed
Please change in your codebase:
diff --git a/docs/developer/upgrades/4.4-to-4.5.mdx b/docs/developer/upgrades/4.4-to-4.5.mdx
index d067c1013e..129e8b166d 100644
--- a/docs/developer/upgrades/4.4-to-4.5.mdx
+++ b/docs/developer/upgrades/4.4-to-4.5.mdx
@@ -13,11 +13,15 @@ If you're on an older version than 4.4 please follow previous upgrade guides and
## Upgrade Rails
-Rails 6.0 is no longer supported - if you haven’t already, you’ll need to upgrade to **Rails 6.1 or 7.0**.
+<Warning>
+Rails 6.0 is no longer supported - if you haven’t already, you’ll need to upgrade to **Rails 6.1 or 7.x**.
+</Warning>
-The effort to upgrade to Rails 6.1 is relatively low, but brings a lot of improvements around ActiveStorage and handling of CDNs. See the Rails docs [for upgrading from 6.0 to 6.1](https://edgeguides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-6-0-to-rails-6-1), and for [upgrading from 6.1 to 7.0](https://edgeguides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-6-1-to-rails-7-0).
+The effort to upgrade to Rails 6.1 is relatively low and brings a lot of improvements around ActiveStorage and handling of CDNs. See the Rails docs [for upgrading from 6.0 to 6.1](https://edgeguides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-6-0-to-rails-6-1), and for [upgrading from 6.1 to 7.0](https://edgeguides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-6-1-to-rails-7-0).
+<Note>
If using Rails 7, you will need to [install libvips](https://www.libvips.org/install.html) on your cloud environment, as Rails 7 uses vips as its default variant processor. You can still use imagemagick, but you’ll need to manually set it in your [Rails config](https://edgeapi.rubyonrails.org/classes/ActiveStorage/Variant.html).
+</Note>
### Rails 7 specific changes