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

Ported shipping guide documentation from Spree #1966

Merged
merged 3 commits into from
Jun 6, 2017

Conversation

Reddshift
Copy link
Contributor

This could be polished a bit more - but Clarke just announced in SolidusConf that he would be hiring a technical writer to work on implementation guides and documentation. so I thought I would create a pull request with what I have so far. If this gets merged and helps some people in the meantime, great! If we all feel like it would be better to wait for a more polished version - great too!

I Started with a copy of the Spree doc was pulled (https://github.com/spree/spree-guides/blob/master/content/developer/core/shipments.md) and made the following edits (among others)

  • Confirmed as much as possible that Solidus still works as described in the spree documentation. Fixed as needed.
  • Refined descriptions and explanations in (hopefully) appropriate ways
  • Only used ticks for things that could actually be in code or typed at a terminal or console.
  • Reorganized examples to come after definitions
  • Changed the “Note” callout pattern to a bold word with italic text instead of horizontal rules
  • Replaced “Spree” with “Solidus” as appropriate

Questions for feedback:

  • Stock splitting documentation - I just confirmed the paths are correct and files exist in solidus, I didn’t confirm that function in solidus has not changed
  • Should we include the documentation (essentially a recommendation or promotion) of the solidus_active_shipping extension? The extension itself acknowledges that it is old, complex, and needs some work. I didn’t have time to test the example code in solidus, but I did confirm that all objects/classes referred to exist, and the examples look sound.
  • Wondering how to appropriately acknowledge that the document originated from the spree guide…

Reddshift added 3 commits May 23, 2017 09:46
* only used ticks for things that could actually be in code or typed at
a terminal or console.
* Reorganized examples section to come after definitions
* changed the “Note” callout pattern to bold word with italic text
instead of horizontal rules
* confirmed functionality of shipping_instructions configuration option
* confirmed various other documented options to make sure solidus still
behaves the same way.

Todo:
* Advanced shipping methods section - reference to extensions, etc.
* Review the remaider of the doc (from advanced shipping to the end)
Fixed references to Spree and reviewed examples for obvious changes
or differences between Spree and Solidus.
@Reddshift Reddshift mentioned this pull request May 24, 2017
8 tasks
@mamhoff
Copy link
Contributor

mamhoff commented May 27, 2017

Clarkes announcement does not preclude the community from porting Spree documentation. The person that will be hired will have lots to do either way, so I suggest going on with community-delivered guides.

@Reddshift this is an amazing effort, an I would very much like to see this merged as it still is a pretty good guide.

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.

Thank you!

@Reddshift
Copy link
Contributor Author

Sounds good @mamhoff -- porting the Spree guides is fairly low effort compared to the extensive work that could be done to take documentation further. I agree that it is worth doing, even just to have some documentation until someone is hired. I'll try to fit in porting some more...

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.

2 participants