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 #2784

Closed

Conversation

benjaminwil
Copy link
Contributor

This adds documentation about the Solidus shipping interface for end users. The audience for this documentation is store administrators or anyone who has to touch the solidus_backend as a business person.

It also changes some of the English translation strings for the backend interface, which is a minor UX improvement.

Copy link
Member

@tvdeyen tvdeyen left a comment

Choose a reason for hiding this comment

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

Would love to have this in. There is a yaml syntax error causing the tests to fail. Would you mind fixing it?

core/config/locales/en.yml Outdated Show resolved Hide resolved
@benjaminwil benjaminwil force-pushed the user_guides/settings/shipping branch from f7029f8 to adec11c Compare October 5, 2018 23:29
@benjaminwil
Copy link
Contributor Author

Fixed! Sorry about that.

@benjaminwil benjaminwil force-pushed the user_guides/settings/shipping branch from adec11c to 3ec9897 Compare October 9, 2018 16:26
Copy link
Contributor

@ericsaupe ericsaupe left a comment

Choose a reason for hiding this comment

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

Looks good! Would you mind squashing your commits?

I'm not sure if the spec failures are related to a fix that was recently pushed to master but it might be a good idea to rebase just to be sure.

Thanks!

@benjaminwil benjaminwil force-pushed the user_guides/settings/shipping branch from 3ec9897 to ddb3676 Compare October 18, 2018 16:44
-----------------------------------------------------------------------

This commit improves the user experience of the "Stores" page in the
admin interface in the following ways:

- It clarifies what the "Code" field does.
- It renames the the code field "Slug" in the UI only. This is less
  ambiguous for users who are creating a new store and don't know what
  to put in this field.
- It ensures that all of the fields on the page have the same
  capitalization style.

Note: The UX is still pretty bad. We do not want admins to think making
changes to stores is trivial. We should rethink this page and make more
major changes to it.

Mark "Name" as required for new shipping methods
-----------------------------------------------------------------------

When a store admin creates a new shipping method, the "Name" field
should be marked as required.

This commit also cleans up some extra spacing in the new shipping method
form and fixes the data hook for `admin_name`, which was mis-named to
say `internal_name`.

Update locales strings
-----------------------------------------------------------------------

This commit removes unused locales strings. It also changes the
capitalization of some existing locales strings so that the stock
locations form has consistent capitalization.
This commit adds information about everything store administrators need
to get started with the `solidus_backend` interface at the URI
`/admin/settings/shipping`.

- Tweak product SEO docs; add links to stores docs
- Add all settings article stubs
- Add shipping settings docs for end users
- Adds information about shipping calculators and stock locations.
@benjaminwil benjaminwil force-pushed the user_guides/settings/shipping branch from ddb3676 to 2b952f5 Compare October 18, 2018 16:45
Copy link
Contributor

@jacobherrington jacobherrington left a comment

Choose a reason for hiding this comment

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

Is this something we still plan to get in? It looks good to me.

Copy link
Contributor

@ericsaupe ericsaupe left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@kennyadsl
Copy link
Member

Closing, I'm reopened this into #3092. Thanks anyway @benjaminwil!

@kennyadsl kennyadsl closed this Feb 8, 2019
@benjaminwil
Copy link
Contributor Author

No problem. Didn't intend to abandon this, and I fixed that YML – why couldn't we merge it?

@kennyadsl
Copy link
Member

There was a conflict in the yml file yet so it couldn't allow me to merge. No worries, you have the owership of the commits in the PR I just open, so it does not change much. Thanks again!

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.

5 participants