spree/spree-guides

Thoughts on switching to rubygems references instead of bundling from git.

Senjai opened this issue · 2 comments

In the official docs, there are a few references that are often made to bundling Spree from git.

However this can be confusing and at a high cost to keep updated (as referenced in my PR). When we discuss bundling the latest stable version of spree from Git, the docs have to be updated to reflect that version number to maintain its' accuracy.

One of the issues that came up in IRC today was pertinent to the installation of spree_fancy by following http://guides.spreecommerce.com/developer/extensions_tutorial.html

This gem isn't on ruby gems, so it has to be bundled with git. But it assumes the user is using edge spree, which most extension developers may be doing, but it isn't explicitly stated. If it is meant for a stable version, maintaining the accurate version adds a cost of change in the long run and maybe it should be cut to ruby gems if it's going to be used in the tutorial?

Besides the contributor documents, should reference just be made to the ruby gems version with references to bundling to git only made in the scenario of promoting using the edge version?

I'd be happy to work at accomplishing this if there is support for the idea.

cc @radar

It's much easier to push the changes to GitHub rather than to push the changes to GitHub AND do a RubyGems release. Extensions being made available on GitHub is the easiest way that we know to provide them.

The guide was just missing the 2-1-stable branch from the gem line, and I've added that now in a new commit to both the 2-1-x and master branches of this guides repo. There's also a note to direct people what to do if they're not using 2.1.x.

Ahh duely noted.

Thanks Radar.