Why new guides?
A while back, we put a lot of work into creating documentation for our API independent of the developer guides. Our designer Alexey (aka devilcoders) did a great job on the API guides, and we wanted to bring that great work into the developer guides as well. We also used this as an opportunity to go through the guides and clean out things that were confusing or out of date. To top it off, John Dyer ( LBRapid ) put together a few new tutorials, going step by step through getting started with Spree and using and creating extensions and deface overrides.
Starting with Edge
Currently, the new guides are available on Edge. Edge is our repository for documentation about Spree features that haven’t been released yet. Once the next major Spree version is released, the guides in the Edge repository will replace the current guides. We will continue to make the old guides available as we have in the past with our legacy guides. The Edge guides include documentation on the new Split Shipments functionality included in Spree 2.0. Make sure to give this section a read and let us know what you think about the new feature.
Preview the Spree Integrator
You’ll notice we included a section in the Guides called The Spree Integrator. The Spree Integrator is a project our team has been quietly working on the last six months and is the pillar of our new Spree Professional packages. The Spree Integrator is a new platform for extending the reach of your Spree store into a myriad of crucial business applications and services like drop shipping providers, accounting systems, transactional email services, custom applications and much more. Brian Quinn will explain more about the Spree Integrator at SpreeConf and will show how easily you can get started using the off-the-shelf services that we’ve built into the Spree Integrator and how you can create custom endpoints to process all the events as they happen in your store.
A Community Effort
While the Spree core team and staff did a lot of the work getting the guides converted, there were a number of community members who also contributed. We had 229 commits by 29 authors, including 14 commits by first time open source contributor Dana Jones. You can see all the contributions in a github compare
We couldn’t do it without you! Especially if you’re new to Spree, or new to contributing to open source, the guides are a great place to get started. There’s constantly cleanup and improvement to be done. To contribute, simply follow the instructions here.
Watch for More
There’s more coming! We’re going to be looking at improving the developer guides in the future, as well as adding a guide section for users, covering things like how to use the admin interface. If you’ve got ideas for how we can continue to improve the guides, submit a pull request, leave a comment on this post, or open an issue on the repo.
Come Meet us at SpreeConf
The next SpreeConf is taking place May 20th – 21st in Washington, DC. SpreeConf is a great opportunity to learn more about what’s coming in Spree 2.0 and how to apply it to your store. We also have a great lineup of speakers from both the e-commerce and Ruby communities. Don’t miss your chance to meet the Spree core team in person and to connect with the rest of the Spree Community. Get $75 off with code “GUIDES” when registering at the link below.