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.

Replace links to guides.spreecommerce.org with dev-docs.spreecommerce.org (#11250)

Damian Legawiec09f081b202ab
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index e0bbd3fee2..398a9364eb 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1 +1 @@
-Please visit [Contributing section](http://guides.spreecommerce.org/developer/contributing/) of Spree Guides. Thank you!
+Please visit [Contributing section](https://dev-docs.spreecommerce.org/contributing/index) of Spree Guides. Thank you!
diff --git a/README.md b/README.md
index 9f403d92c3..7c17b66a26 100755
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@
[![Gem Version](https://badge.fury.io/rb/spree.svg)](https://badge.fury.io/rb/spree) [![Circle CI](https://circleci.com/gh/spree/spree.svg?style=shield)](https://circleci.com/gh/spree/spree/tree/master) [![Test Coverage](https://api.codeclimate.com/v1/badges/8277fc2bb0b1f777084f/test_coverage)](https://codeclimate.com/github/spree/spree/test_coverage)
-**Spree** is a headless open source e-commerce platform for global brands. It was started by Sean Schofield and is now developed by [Spark Solutions][spark]. We're open to [contributions](https://guides.spreecommerce.org/developer/contributing/).
+**Spree** is a headless open source e-commerce platform for global brands. It was started by Sean Schofield and is now developed by [Spark Solutions][spark]. We're open to [contributions](https://dev-docs.spreecommerce.org/contributing/index).
## Key Features
@@ -58,7 +58,7 @@ Admin panel credentials for your own Heroku demo:
### Option B - add Spree to an existing Ruby on Rails application
-1. [Please follow Add Spree to an existing Ruby on Rails application tutorial](https://guides.spreecommerce.org/developer/advanced/existing_app_tutorial.html)
+1. [Please follow Add Spree to an existing Ruby on Rails application tutorial](https://dev-docs.spreecommerce.org/advanced/existing_app_tutorial)
## Documentation
@@ -84,7 +84,7 @@ Spree is released under the [New BSD License](https://github.com/spree/spree/blo
[![Spark Solutions](http://sparksolutions.co/wp-content/uploads/2015/01/logo-ss-tr-221x100.png)][spark]
-[Spark Solutions][spark] is a full stack eCommerce agency specialized in Spree Commerce, Ruby on Rails and JavaScript. We’ve been leading Spree open-source efforts since 2016 as its core team. We also do client work. Our project teams consist of Designers, Software Engineers, Testers and Project Managers practicing agile project delivery. We’ll integrate our team with yours to jointly architect, deliver, maintain and scale the software products you need. You drive the project with requirements and acceptance testing and we help you deliver faster using industry-standard project management and comms best practices.
+[Spark Solutions][spark] is a full stack eCommerce agency. We’ve been leading Spree open-source efforts since 2016 as its core team. We also do client work. Our project teams consist of Designers, Software Engineers, Testers and Project Managers practicing agile project delivery. We’ll integrate our team with yours to jointly architect, deliver, maintain and scale the software products you need. You drive the project with requirements and acceptance testing and we help you deliver faster using industry-standard project management and comms best practices.
We are passionate about open source software.
We are [available for hire][spark].
diff --git a/SECURITY.md b/SECURITY.md
index 14f74db9b0..1f33b77048 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -1 +1 @@
-Please see [Spree Guides Security section](https://guides.spreecommerce.org/developer/security/).
+Please see [Spree Guides Security section](https://dev-docs.spreecommerce.org/security/index).
diff --git a/api/docs/v2/storefront/index.yaml b/api/docs/v2/storefront/index.yaml
index 35913dda14..f28ea6973f 100644
--- a/api/docs/v2/storefront/index.yaml
+++ b/api/docs/v2/storefront/index.yaml
@@ -869,7 +869,7 @@ paths:
PATCH /checkout/complete
```
- This will complete the Checkout and mark the Order as completed. You cannot execute any operations on this Order anymore via Storefront API. Further operations on the Order are possible via [Spree API v1](https://guides.spreecommerce.org/api/).
+ This will complete the Checkout and mark the Order as completed. You cannot execute any operations on this Order anymore via Storefront API. Further operations on the Order are possible via Platform API.
tags:
- Checkout
operationId: Update Checkout
@@ -1009,7 +1009,7 @@ paths:
summary: Complete Checkout
/api/v2/storefront/checkout/add_store_credit:
post:
- description: 'Adds Store Credit payment if the currently signed in User has any available. [Read more about Store Credits](https://guides.spreecommerce.org/user/users/editing_users.html#store-credits)'
+ description: 'Adds Store Credit payment if the currently signed in User has any available.'
tags:
- Checkout
operationId: Add Store Credit
@@ -3538,7 +3538,7 @@ paths:
summary: Get Product Details
/api/v2/storefront/taxons:
get:
- description: 'Returns a list of Taxons. [Read more about Taxons](https://guides.spreecommerce.org/developer/core/products.html#taxons-and-taxonomies)'
+ description: 'Returns a list of Taxons. [Read more about Taxons](https://dev-docs.spreecommerce.org/internals/products#taxons-and-taxonomies)'
tags:
- Taxons
operationId: Taxons List
@@ -4060,7 +4060,7 @@ components:
- included
x-examples: {}
type: object
- description: 'Cart provides a central place around which to collect information about a customer order - including line items, adjustments, payments, addresses, return authorizations, and shipments. [Read more in Spree docs](https://guides.spreecommerce.org/developer/core/orders.html)'
+ description: 'Cart provides a central place around which to collect information about a customer order - including line items, adjustments, payments, addresses, return authorizations, and shipments. [Read more in Spree docs](https://dev-docs.spreecommerce.org/internals/orders)'
CartList:
required:
- data
@@ -4245,7 +4245,7 @@ components:
- confirm
- complete
description: |-
- State of the Cart in the Checkout flow. Please see <a href="https://guides.spreecommerce.org/developer/core/orders.html#the-order-state-machine">
+ State of the Cart in the Checkout flow. Please see <a href="https://dev-docs.spreecommerce.org/internals/orders#the-order-state-machine">
The Order State machine
</a> for a full list with description.
payment_state:
@@ -4258,7 +4258,7 @@ components:
- paid
- void
description: |-
- Overall state of the Payments. Please see <a href="https://guides.spreecommerce.org/developer/core/orders.html#order-payment-states">
+ Overall state of the Payments. Please see <a href="https://dev-docs.spreecommerce.org/internals/orders#order-payment-states">
Order Payments states
</a> for a full list with description.
shipment_state:
@@ -4272,16 +4272,14 @@ components:
- ready
- shipped
description: |-
- Overall state of the Shipments. Please see <a href="https://guides.spreecommerce.org/developer/core/orders.html#order-shipment-states">
+ Overall state of the Shipments. Please see <a href="https://dev-docs.spreecommerce.org/internals/orders#order-shipment-states-1">
Order Shipments states
</a> for a full list with description.
token:
type: string
example: abcdef123456
description: |-
- Used for authorizing any action for an Order within Spree’s API. Please see <a href="https://guides.spreecommerce.org/api/v2/storefront#section/Authentication/orderToken">
- Order Token Authentication
- </a> for more information.
+ Used for authorizing any action for an Order within Spree’s API.
CreditCardList:
required:
- included
@@ -5080,7 +5078,7 @@ components:
items:
oneOf:
- $ref: '#/components/schemas/State'
- description: 'Countries within Spree are used as a container for states. Countries can be zone members, and also link to an address. The difference between one country and another on an address record can determine which tax rates and shipping methods are used for the order.[Read more about Countries in Spree](https://guides.spreecommerce.org/developer/core/addresses.html#countries)'
+ description: 'Countries within Spree are used as a container for states. Countries can be zone members, and also link to an address. The difference between one country and another on an address record can determine which tax rates and shipping methods are used for the order.[Read more about Countries in Spree](https://dev-docs.spreecommerce.org/internals/addresses#countries)'
CountriesList:
required:
- data
@@ -5243,7 +5241,7 @@ components:
- shipped
- canceled
description: |-
- Status of the Shipment. For a list of all available statuses please refer: <a href="https://guides.spreecommerce.org/developer/shipments.html#overview" target="_blank" rel="noopener">
+ Status of the Shipment. For a list of all available statuses please refer: <a href="https://dev-docs.spreecommerce.org/internals/shipments" target="_blank" rel="noopener">
Shipment section in Spree Guides
</a>
shipped_at:
diff --git a/api/spree_api.gemspec b/api/spree_api.gemspec
index 31c8b6b5ee..f3880d5ac7 100644
--- a/api/spree_api.gemspec
+++ b/api/spree_api.gemspec
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
s.metadata = {
"bug_tracker_uri" => "https://github.com/spree/spree/issues",
"changelog_uri" => "https://github.com/spree/spree/releases/tag/v#{s.version}",
- "documentation_uri" => "https://guides.spreecommerce.org/",
+ "documentation_uri" => "https://dev-docs.spreecommerce.org/",
"source_code_uri" => "https://github.com/spree/spree/tree/v#{s.version}",
}
diff --git a/backend/app/views/spree/admin/shared/_account_nav.html.erb b/backend/app/views/spree/admin/shared/_account_nav.html.erb
index baa22c2e47..d976ac048a 100644
--- a/backend/app/views/spree/admin/shared/_account_nav.html.erb
+++ b/backend/app/views/spree/admin/shared/_account_nav.html.erb
@@ -37,7 +37,7 @@
<div class="dropdown-divider m-0"></div>
- <%= link_to 'http://guides.spreecommerce.org/support', target: :blank, class: 'd-block text-dark py-3 px-4 dropdown-item' do %>
+ <%= link_to 'http://spreecommerce.org/contact', target: :blank, class: 'd-block text-dark py-3 px-4 dropdown-item' do %>
<%= svg_icon name: "info.svg", width: '18', height: '18' %>
&nbsp;
<%= Spree.t(:support) %>
@@ -49,7 +49,7 @@
<%= Spree.t(:join_slack) %>
<% end %>
- <%= link_to 'https://guides.spreecommerce.org/extensions', target: :blank, class: 'd-block text-dark py-3 px-4 dropdown-item' do %>
+ <%= link_to 'https://dev-docs.spreecommerce.org/extensions/extensions', target: :blank, class: 'd-block text-dark py-3 px-4 dropdown-item' do %>
<%= svg_icon name: "extensions.svg", width: '18', height: '18' %>
&nbsp;
<%= Spree.t(:extensions_directory) %>
diff --git a/backend/spree_backend.gemspec b/backend/spree_backend.gemspec
index 0dc7803e1d..48f8974b74 100644
--- a/backend/spree_backend.gemspec
+++ b/backend/spree_backend.gemspec
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
s.metadata = {
"bug_tracker_uri" => "https://github.com/spree/spree/issues",
"changelog_uri" => "https://github.com/spree/spree/releases/tag/v#{s.version}",
- "documentation_uri" => "https://guides.spreecommerce.org/",
+ "documentation_uri" => "https://dev-docs.spreecommerce.org/",
"source_code_uri" => "https://github.com/spree/spree/tree/v#{s.version}",
}
diff --git a/cmd/lib/spree_cmd/templates/extension/app/models/%file_name%/configuration.rb.tt b/cmd/lib/spree_cmd/templates/extension/app/models/%file_name%/configuration.rb.tt
index 12595e63cd..214f716596 100644
--- a/cmd/lib/spree_cmd/templates/extension/app/models/%file_name%/configuration.rb.tt
+++ b/cmd/lib/spree_cmd/templates/extension/app/models/%file_name%/configuration.rb.tt
@@ -2,7 +2,7 @@ module <%= class_name %>
class Configuration < Spree::Preferences::Configuration
# Some example preferences are shown below, for more information visit:
- # https://guides.spreecommerce.org/developer/core/preferences.html
+ # https://dev-docs.spreecommerce.org/internals/preferences
# preference :visible, :boolean
# preference :dark_chocolate, :boolean, default: true
diff --git a/cmd/spree_cmd.gemspec b/cmd/spree_cmd.gemspec
index 4ce978b652..deb6eacb6f 100644
--- a/cmd/spree_cmd.gemspec
+++ b/cmd/spree_cmd.gemspec
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
s.metadata = {
"bug_tracker_uri" => "https://github.com/spree/spree/issues",
"changelog_uri" => "https://github.com/spree/spree/releases/tag/v#{s.version}",
- "documentation_uri" => "https://guides.spreecommerce.org/",
+ "documentation_uri" => "https://dev-docs.spreecommerce.org/",
"source_code_uri" => "https://github.com/spree/spree/tree/v#{s.version}",
}
diff --git a/core/spree_core.gemspec b/core/spree_core.gemspec
index d868bfcc76..117551abfb 100644
--- a/core/spree_core.gemspec
+++ b/core/spree_core.gemspec
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
s.metadata = {
"bug_tracker_uri" => "https://github.com/spree/spree/issues",
"changelog_uri" => "https://github.com/spree/spree/releases/tag/v#{s.version}",
- "documentation_uri" => "https://guides.spreecommerce.org/",
+ "documentation_uri" => "https://dev-docs.spreecommerce.org/",
"source_code_uri" => "https://github.com/spree/spree/tree/v#{s.version}",
}
diff --git a/emails/spree_emails.gemspec b/emails/spree_emails.gemspec
index f5f7c8240e..f8d5ec137b 100644
--- a/emails/spree_emails.gemspec
+++ b/emails/spree_emails.gemspec
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
s.metadata = {
"bug_tracker_uri" => "https://github.com/spree/spree/issues",
"changelog_uri" => "https://github.com/spree/spree/releases/tag/v#{s.version}",
- "documentation_uri" => "https://guides.spreecommerce.org/",
+ "documentation_uri" => "https://dev-docs.spreecommerce.org/",
"source_code_uri" => "https://github.com/spree/spree/tree/v#{s.version}",
}
diff --git a/frontend/spree_frontend.gemspec b/frontend/spree_frontend.gemspec
index df8d471eaa..8cba36123d 100644
--- a/frontend/spree_frontend.gemspec
+++ b/frontend/spree_frontend.gemspec
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
s.metadata = {
"bug_tracker_uri" => "https://github.com/spree/spree/issues",
"changelog_uri" => "https://github.com/spree/spree/releases/tag/v#{s.version}",
- "documentation_uri" => "https://guides.spreecommerce.org/",
+ "documentation_uri" => "https://dev-docs.spreecommerce.org/",
"source_code_uri" => "https://github.com/spree/spree/tree/v#{s.version}",
}
diff --git a/sample/spree_sample.gemspec b/sample/spree_sample.gemspec
index dfd05a5e5f..ee3c8567b8 100644
--- a/sample/spree_sample.gemspec
+++ b/sample/spree_sample.gemspec
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
s.metadata = {
"bug_tracker_uri" => "https://github.com/spree/spree/issues",
"changelog_uri" => "https://github.com/spree/spree/releases/tag/v#{s.version}",
- "documentation_uri" => "https://guides.spreecommerce.org/",
+ "documentation_uri" => "https://dev-docs.spreecommerce.org/",
"source_code_uri" => "https://github.com/spree/spree/tree/v#{s.version}",
}
diff --git a/spree.gemspec b/spree.gemspec
index c5dfc9ac33..29f5ca548d 100644
--- a/spree.gemspec
+++ b/spree.gemspec
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
s.metadata = {
"bug_tracker_uri" => "https://github.com/spree/spree/issues",
"changelog_uri" => "https://github.com/spree/spree/releases/tag/v#{s.version}",
- "documentation_uri" => "https://guides.spreecommerce.org/",
+ "documentation_uri" => "https://dev-docs.spreecommerce.org/",
"source_code_uri" => "https://github.com/spree/spree/tree/v#{s.version}",
}