Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add initial shipments documentation for end users #3092

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions backend/app/views/spree/admin/shipping_methods/_form.html.erb
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
<div data-hook="admin_shipping_method_form_fields" class="row">
<div data-hook="admin_shipping_method_form_name_field" class="col-5">
<%= f.field_container :name do %>
<%= f.label :name %><br />
<%= f.label :name, class: 'required' %>
<%= f.text_field :name, class: 'fullwidth' %>
<%= error_message_on :shipping_method, :name %>
<% end %>
</div>

<div data-hook="admin_shipping_method_form_internal_name_field" class="col-5">
<%= f.field_container :admin_name do %>
<%= f.label :admin_name %><br />
<%= f.text_field :admin_name, class: 'fullwidth', label: false %>
<%= f.label :admin_name %>
<%= f.text_field :admin_name, class: 'fullwidth', label: false %>
<%= error_message_on :shipping_method, :admin_name %>
<% end %>
</div>

<div data-hook="admin_shipping_method_form_code" class="col-5">
<%= f.field_container :code do %>
<%= f.label :code %><br />
<%= f.text_field :code, class: 'fullwidth', label: false %>
<%= f.label :code %>
<%= f.text_field :code, class: 'fullwidth', label: false %>
<%= error_message_on :shipping_method, :code %>
<% end %>
</div>

<div class="col-5">
<%= f.field_container :carrier do %>
<%= f.label :carrier %><br />
<%= f.text_field :carrier, class: 'fullwidth', label: false %>
<%= f.label :carrier %>
<%= f.text_field :carrier, class: 'fullwidth', label: false %>
<%= error_message_on :shipping_method, :carrier %>
<% end %>
</div>

<div class="col-5">
<%= f.field_container :service_level do %>
<%= f.label :service_level %><br />
<%= f.text_field :service_level, class: 'fullwidth', label: false %>
<%= f.label :service_level %>
<%= f.text_field :service_level, class: 'fullwidth', label: false %>
<%= error_message_on :shipping_method, :service_level %>
<% end %>
</div>
Expand All @@ -49,7 +49,7 @@

<div data-hook="admin_shipping_method_form_tracking_url_field" class="col-10">
<%= f.field_container :tracking_url do %>
<%= f.label :tracking_url %><br />
<%= f.label :tracking_url %>
<%= f.text_field :tracking_url, class: 'fullwidth', placeholder: t('spree.tracking_url_placeholder') %>
<%= error_message_on :shipping_method, :tracking_url %>
<% end %>
Expand Down
1 change: 1 addition & 0 deletions backend/app/views/spree/admin/stores/_form.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

<%= f.field_container :code do %>
<%= f.label :code, class: 'required' %>
<%= f.field_hint :code %>
<%= f.text_field :code, required: true, class: 'fullwidth' %>
<%= f.error_message_on :code %>
<% end %>
Expand Down
9 changes: 5 additions & 4 deletions core/config/locales/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,6 @@ en:
country_id: Country
default: Default
fulfillable: Fulfillable
internal_name: Internal Name
name: Name
phone: Phone
propagate_all_variants: Propagate All Variants
Expand All @@ -332,6 +331,7 @@ en:
spree/store:
available_locales: Locales Available in the Storefront
cart_tax_country_iso: Tax Country for Empty Carts
code: Slug
default: Default
default_currency: Default Currency
mail_from_address: Mail From Address
Expand Down Expand Up @@ -1417,8 +1417,10 @@ en:
spree/store:
available_locales: This determines which locales are available for your customers
to choose from in the storefront.
cart_tax_country_iso: 'This determines which country is used for taxes on
carts (orders which don''t yet have an address).<br/> Default: None.'
cart_tax_country_iso: "This determines which country is used for taxes on carts
(orders which don't yet have an address).<br/> Default: None."
code: 'An identifier for your store. Developers may need this value if you operate
multiple storefronts.'
spree/tax_rate:
validity_period: This determines the validity period within which the tax
rate is valid and will be applied to eligible items. <br /> If no start
Expand Down Expand Up @@ -1470,7 +1472,6 @@ en:
quantity.
intercept_email_address: Intercept Email Address
intercept_email_instructions: Override email recipient and replace with this address.
internal_name: Internal Name
invalid_exchange_variant: Invalid exchange variant.
invalid_payment_method_type: Invalid payment method type.
invalid_promotion_action: Invalid promotion action.
Expand Down
4 changes: 4 additions & 0 deletions guides/data/nav/users.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@
href: "/users/settings/taxes.html"
- title: "Zones"
href: "/users/settings/zones.html"
- title: "Shipping"
href: "/users/settings/shipping.html"
- title: "Stores"
href: "/users/settings/stores.html"

- title: "Stock"
dropdown:
Expand Down
1 change: 1 addition & 0 deletions guides/source/users/orders/shipments.html.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Shipments
15 changes: 10 additions & 5 deletions guides/source/users/products/product-details.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ would have the slug `summer-t-shirt`.
### Available On

Note that the **Available On** field should be filled if you want the product to
be displayed on the storefront.
be displayed on the storefront.

If the **Available On** value is a date in the future, then the product is only
available after the date that has been set.
Expand All @@ -51,8 +51,8 @@ systems:
products.
- **Weight**: The product's weight.
- **Height**: The product's height.
- **Width**: The product's width.
- **Depth**: The product's depth.
- **Width**: The product's width.
- **Depth**: The product's depth.
- **Shipping Categories**: This sets the product's shipping category.
- **Tax Category**: This sets the products' tax category.

Expand All @@ -69,13 +69,17 @@ order's shipment costs.

## SEO information

- **Meta Title**:
- **Meta Keywords**: Add a list of keywords that should be added to this
- **Meta Title**: Adds content to the product page's HTML `<title>` tag, which
is used by search engines.
- **Meta Keywords**: A list of keywords that should be added to this
product's metadata. These meta keywords are used by search
engines.[^meta-keywords]
- **Meta Description**: The summary text that accompanies your page in search
engine results.[^meta-descriptions]

If the product's SEO fields are not filled in, then the product inherits [the
store's global SEO information settings][stores].

[^meta-keywords]: Meta keywords are used for SEO purposes. For more information
about meta keywords see the article [Meta Keywords: What They Are and How They
Work][meta-keywords] from WordStream.
Expand All @@ -87,3 +91,4 @@ order's shipment costs.

[meta-keywords]: https://www.wordstream.com/meta-keyword
[meta-description]: https://moz.com/learn/seo/meta-description
[stores]: ../settings/stores.html
62 changes: 56 additions & 6 deletions guides/source/users/settings/overview.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,62 @@ Solidus's **Settings** section includes a number of pages that help you manage
store-wide settings, including tax rates, shipping methods, and payment methods.

This article introduces each settings page and how the settings affect your
store.
store.

## Stores

The **Settings > Stores** page allows you to manage some of the global settings
across all of your stores. These global settings include your site's name,
site-wide SEO tag data, and the sender email address used when emails are sent
by your store.

If your Solidus application manages multiple stores, you can choose the store
you want to edit from a list.

For more information about these settings, see the [Stores][stores] article.

[stores]: stores.html

## Payments

You can manage Solidus's available payment methods from the **Settings >
Payments** page. Typically, a payment method is displayed as an option that
customers can use to pay at checkout.

For more information about managing payment methods, see the
[Payments][payments] article.

[payments]: payments.html

## Taxes

You can manage the tax rates and categories that Solidus uses from the
**Settings > Taxes** page. Solidus's taxes relate to shipping charges as well as
the products that you sell.

For more information about tax management, see the [Taxes][taxes] article.

[taxes]: taxes.html

## Refunds and Returns

You can manage Solidus's returns system from the **Settings > Refunds and
Returns** page. Because the returns system is flexible, there are many settings.

For more information about managing Solidus's returns system, see the [Refunds
and returns][returns] article.

[returns]: refunds-and-returns.html

## Shipping

You can manage Solidus's available shipping methods, shipping categories, and
stock locations from the **Settings > Shipping** page.

For more information about managing Solidus's shipping settings, see the
[Shipping][shipping] article.

[shipping]: shipping.html

## Zones

Expand All @@ -15,8 +70,3 @@ and/or tax. A country or state could exist in multiple zones or none at all.
For more information on how to use zones, see the [Zones][zones] article.

[zones]: zones.html

## Taxes

With Solidus, you can create tax rates and tax categories that correspond with
each item in your store and each location that you ship to.
4 changes: 4 additions & 0 deletions guides/source/users/settings/payments.html.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Payments

You can manage your store's payment methods form the **Settings > Payments**
page.
4 changes: 4 additions & 0 deletions guides/source/users/settings/refunds-and-returns.html.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Refunds and returns

You can manage Solidus's returns system from the **Settings > Refunds and
Returns** page.
Loading