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

Locations documentation #2375

Merged
merged 4 commits into from
Jan 2, 2018

Conversation

benjaminwil
Copy link
Contributor

I've created three short articles about locations in Solidus:

  • An overview about zones, countries, and states.
  • An article specifically about countries and states. This article may be built upon in the future.
  • An article specifically about zones, which includes an example of how a store might set up zones.

My goals are to:

  • Give more context to Solidus's basic locations concepts. Developers who are new to Solidus should be able to understand locations from a business perspective and then a development perspective.
  • Use article titles, headings, and sub-headings to make it easier for developers to discover the specific information about shipments that they are looking for. They should be able to skim and scan each article quickly.
  • Provide some scaffolding for when there's additional documentation about locations.
  • Provide more a realistic example of how zones might be set up in a store.

This is part a larger project to improve Solidus's documentation. See this gist with the high-level table of contents. Where and how this documentation will exist is still up for discussion.

Currently, this article describes how zones affect taxation and
shipment setup for administrators. This article also provides an
example of how a store might set up their zones.
Copy link
Contributor

@mamhoff mamhoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice, clear and concise. I have a small addendum, otherwise this is great.

## States

A state is any sub-region of a country, whether that is a province, district, or
territory. If the state you require is not recognized, you can add it directly
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For some countries, dividing them up into sub-territories makes no sense. For those cases, we can determine that the states_required field on the country is set to false.

If we do that, then the subregions for that country are not chosen for addresses.

This makes sense for many European countries and any small country.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a note about this. 👍

@benjaminwil benjaminwil mentioned this pull request Nov 21, 2017
## Countries

If a country or state you require is not recognized, you can add it directly
from the Solidus admin (**Settings -> Locations -> Countries**) or from your
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You actually can't add states or countries from Settings -> Locations -> ... anymore. This needs to be updated.

It is no longer possible to add custom countries or states from the
Solidus admin. I also added a note about the `states_required` field
on `Spree::Country` objects.
@jhawthorn jhawthorn merged commit 7cd39e5 into solidusio:master Jan 2, 2018
@benjaminwil benjaminwil deleted the locations_documentation branch April 30, 2018 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants