http://guides.spreecommerce.com/customization_tutorial.html still mentions to use script/generate.

There is no documentation for the images part of Spree's API.

http://edgeguides.spreecommerce.com/checkout.html

4.2.1 REMOVING A CHECKOUT STEP doesn't use Namespaced Order objects, so the code will definitely not work. The rest of the snippet should be looked at as well...

This option has been added in spree/spree#2302.

Registering Calculators isn't hard, but it's not well documented. We should improve the documentation on creating them and registering them.

With the latest changes from the namespace branch, The "Getting Started" guide does not mention that you need to mount the core engine. Without this, the application will be barren.

To mount the engine, use this:

mount Spree::Core::Engine, :at => '/'

Or if you want to mount it at a specific location:

mount Spree::Core::Engine, :at => '/shop'

http://spreecommerce.com/documentation/contributing_to_spree.html

This should probably make some type of mention about GitHub Issues instead of Lighthouse. Are pull requests encouraged now?

Is it the guide that is wrong (see 2.1) or it will be pushed on Rubgems eventually?

As of Radar's instructions on the #spree freenode channel, comment out gem 'spree' in your Gemfile and specify all the dependencies of Spree in your Gemfile minus spree_dash as follows:

gem 'spree'

spree_version = '1.0.3'
gem 'spree_core', spree_version
gem 'spree_auth', spree_version
gem 'spree_api', spree_version

gem 'spree_dash', spree_version

gem 'spree_promo', spree_version

You must actually register your extension in the Extension Registry before it can be discovered by the crawler.

can‘t find information on how to register an extension on spree‘s extensions page http://spreecommerce.com/extensions

The tutorial for generating a new theme, http://guides.spreecommerce.com/customization_tutorial.html, seems to be out of date for the current release of Spree 1.0.0.

Document the Taxons API endpoint.

See the symbol for Pounds from https://github.com/spree/spree-guides/blob/c4cdd7474f1c1a2662d484bde7bc5f8db26289f1/content/developer/core/taxation.md as rendered at http://edgeguides.spreecommerce.com/developer/taxation.html, as well as the symbol for Euros from https://github.com/spree/spree-guides/blob/c4cdd7474f1c1a2662d484bde7bc5f8db26289f1/content/developer/core/products.md as rendered at http://edgeguides.spreecommerce.com/developer/products.html

This is more of a CSS issue, perhaps.

There is no documentation for these endpoints in the API.

Says all this is in admin/all.js

//= require admin/spree_core
//= require admin/spree_auth
//= require admin/spree_api
//= require admin/spree_dash
//= require admin/spree_promo
//= require_tree .

I know spree_api was removed in 1.1, and spree_dash seems to be gone as well.

Don't rush to fix this, I plan to issue a pull request here shortly.

Spree::Config.default_locale no longer exists, and stale initializers will cause issues. The documentation should be updated to reflect this. Something like:

If you are upgrading from a previous version of Spree please be aware Spree::Config.default_locale is no longer used. Any initialzers trying to set it should be removed.

To set the default language simply set config.i18n.default_locale in config/application.rb to your desired language. EG:
config.i18n.default_locale = :ja

In the orange box under http://guides.spreecommerce.com/i18n.html 1.2.2 REQUIRED FILES, the documentation says:

"If you do not need all of the localizations for your project you can skip installation of the spree_i18n gem and just copy the needed Spree translations to #{Rails.root}/ config/locales."

I believe this folder is reserved for rails-i18n translation files and nothing else needs to be copied there. It work just by having spree_i18n in your Gemfile.

There is no documentation for the states API endpoint.

I think that the below information from Ben E. should be put into here:

http://guides.spreecommerce.com/migration.html#product-and-variant-images

The only problem though is that you also need to set all of this as well:

Spree::Image.attachment_definitions[:attachment][:styles] = ActiveSupport::JSON.decode(Spree::Config[:attachment_styles])
Spree::Image.attachment_definitions[:attachment][:path] = Spree::Config[:attachment_path]
Spree::Image.attachment_definitions[:attachment][:url] = Spree::Config[:attachment_url]
Spree::Image.attachment_definitions[:attachment][:default_url] = Spree::Config[:attachment_default_url]
Spree::Image.attachment_definitions[:attachment][:default_style] = Spree::Config[:attachment_default_style]

...I basically had to jimmy-rig it and just copied the model over and comment all that out and it worked fine for both local development and remote production environments. :) Couldn't quickly figure out how to do it with decorators. There isn't a whole lot written about model decorators.

Melissa

On Tuesday, May 1, 2012 7:05:52 PM UTC-7, Ben Eggett wrote:
Robert is correct, spree_heroku is no longer necessary as 1.1/edge supports s3 in the config files:

You can simply add the S3 settings into your config/initializers/spree.rb file::

Spree.config do |config|
config.use_s3 = true
config.s3_bucket = "BUCKET_NAME"
config.s3_access_key = "S3_ACCESS"
config.s3_secret = "S3_SECRET"
end

Seems a bit... weird.

http://edgeguides.spreecommerce.com/developer/view.html

The CheckoutController for the API component has no documentation. We should write some.

Need to update the README with who the audience is for each of the guides (dev, api, user, etc.) to help people use an appropriate tone/degree of technical jargon in contributing.

The default tax category doesn't appear to be explained anywhere in the docs.

http://edgeguides.spreecommerce.com/products_and_variants.html#images is outdated, now it's possible to change this at admin/configuration/image_settings

Edith: Edge-Guides

I have a few screenshots to go along w/the user documentation I'm writing, but I don't see anyplace that images live in the repo. Should I DropBox them, or check them in w/the project somewhere?

Thanks.

On edge, calculated_adjustments doesn't provide "register_calculator(calculator)" method.

Should I fork?

The Shipment Inc VAT boolean doesn't appear to be explained anywhere in the docs.

The UsersController for the API has no documentation.

While trying to deploy to heroku. I keep getting errors to do with gem ransack-v0.7.3 this gem was yanked and is no longer hosed at rubygems. Could you update the guides or something pls

In the new_guides branch, /content/developer/source/navigating.md is out of date - it references, among other things, authlogic.

https://github.com/spree/spree-guides/blob/7b16da558fae1be5ec5767499bf69340f885d075/content/developer/source/navigating.md

Today while working on spree's #825, was reading the docs about calculators. Read that we need to use script/extension install to install an extension. Seems... wrong.

It's here: http://guides.spreecommerce.com/shipping.html#adding-additional-calculators. I feel like I've gone back in time a year.

I don't think that this is the case any more. To install an extension, people should be specifying it in their Gemfile, not installing it as something that's vendor'd. That is, unless they want to edit the code.

There's a dead link on this page leading to http://guides.spreecommerce.com/calculators.html. I'm kinda new here so I am not sure if the calculator reference is still suitable.

In getting started guide, section 4.3. Installing dependencies, is wrong link to spree_static_content gem.
In documentation link is:
gem 'spree_static_content', :git => 'git://github.com/spree/spree-static-content.git'
but should be
gem 'spree_static_content', :git => 'git://github.com/spree/spree_static_content.git' (with underscores)

For some reason, I had to do:

gem install guides

after the bundle install.

Because I was getting:

guides build
/Users/jeffsquires/.rvm/rubies/ruby-1.8.7-p334/lib/ruby/site_ruby/1.8/rubygems.rb:900:in report_activate_error': Could not find RubyGem guides (>= 0) (Gem::LoadError) from /Users/jeffsquires/.rvm/rubies/ruby-1.8.7-p334/lib/ruby/site_ruby/1.8/rubygems.rb:248:inactivate'
from /Users/jeffsquires/.rvm/rubies/ruby-1.8.7-p334/lib/ruby/site_ruby/1.8/rubygems.rb:1276:in `gem'
from ..../bin/guides:18

I'm hesitant to update the install documentation in case I'm doing something silly.

The Ubuntu Deployment guide doesn't cover symlinking an images directory so that all the images aren't lost on subsequent deploys. It really should do that.

As described here: https://groups.google.com/forum/#!msg/spree-user/qBnaLP0V0AU/iPztpdHAzc0J

The instructions at http://guides.spreecommerce.com/creating_extensions.html#getting-started are inaccurate.

spree extension FlagPromotions

actually generates files looking like spree_FlagPromotions instead of the documentation's claimed spree_flag_promotions

The article still refers heavily to devise, it should be updated with the authentication changes.

http://guides.spreecommerce.com/developer_tips.html > links to empty wiki. should be replaced or removed

Segue from a conversation on the spree-user mailing list, I propose we standardize a set of HTML markup conventions for the guides.

RandyT asked if any publishers have a set of standards. I'm sure there are plenty, but I propose we follow the Rails Guides' API conventions for consistency. If there are no major conventions I can own writing these up as part of the README for this project in a (near) future commit. I'm sure we'll probably stumble on some conventions we need that aren't in the Rails Guides, or vice versa.

Thoughts?

From the list:

I'd like to get some consensus on documentation markup conventions. I really think it would help to make all of the docs look a lot more uniform. Obviously, extracted code needs to have the triple-ticks around it to mark it as code, but what kind of markdown habits do we want to use for these:

• Model names in prose (e.g. "When you create a Product object…")
• Buttons (e.g. "Click the Update button.")
• Names of links (e.g. "Click the Images link.")
• Section names (e.g. "In the Purchase Funnel section, you will find…")
• Field names for forms (e.g. "Enter 'Tshirt' in the Name field.")
• State names (e.g. "At this point the order is in the completed state.")

What should be bold? What italicized? What underlined? What marked in ticks? What should have no markdown at all?

Obviously, this isn't an exhaustive list, and it's not meant to be. I would hope we could add to this over time and put it in the README for spree-guides for posterity.

@BDQ, @schof, @radar thought?

I would appreciate a second set of eyes on the Authentication Customization guide I just checked in - 6b0bf58 - specifically the Background section. Just look for the "TODO" note. Thanks!

Ran into a lot of confusion when trying to walk somebody through how to do simple controller decorator in their stand alone application (NOTE: not an extension) w/Spree.

https://gist.github.com/schof/5560963

Needed to do something like:

  mount Spree::Core::Engine, :at => '/'

  Spree::Core::Engine.routes.prepend do
    namespace :admin do
      get '/products/import' => "products#import", :as => :products_import
    end
  end

which was unexpected. We should document the prepend/append stuff for when adding routes to spree namespace.

1. It looks like the step "rails new mystore" should actually be "rails mystore"
2. "Edit the Gemfile in your Rails application by adding the following:" is confusing because at this point the Gemfile doesn't exist yet. It might help if you put in a helpful note like "See below", or better yet put the sample gemfile first (along with instructions to save as "Gemfile" in the project root) and moved the editing instructions below. Also, consider changing '3.0.5' to '>= 3.0.5'
3. 4.3 - consider adding step 4.3 a for windows users that installs "https://github.com/oneclick/rubyinstaller/wiki/Development-Kit". (This took way too long to figure out. Yeah, I know I'm a newb, but that's who the guide is intended for, right?)
4. You should add a custom step before rake db:create for installing sqlite3: see http://accidentaltechnologist.com/ruby-on-rails/setting-up-sqlite3-for-ruby-on-rails-development/
5. Wow! At the asset migration step, I am thoroughly confused. Rails behavior has changed and now the syntax is "rails new ...". However there is no such thing as "rails g spree:site". is the g supposed to be there?

Alright, starting over with a new app.
The development kit and sqllite3 are both installed now. Otherwise, I followed the instructions and I still had issues with http://stackoverflow.com/questions/6181312/how-to-fix-the-uninitialized-constant-rakedsl-problem-on-heroku and http://groups.google.com/group/spree-user/browse_thread/thread/f0772ff704488184.

funny that. All of the sudden, in my new app, rails g spree:site works. In my original path I am still getting the "Usage: ..." output.

After all that, I was finally able to get the new project up and running.

The product scopes are apparently not documented within the guides. These are quite helpful, and I think it'd be a great idea to document them.

Sorry this isn't an issue but more of a question.

I recently submitted a small patch that involved adding a check for image magick during the installation process. I couldn't find any documentation on it so it took me some time to figure out what was going on.

I'm thinking about documenting how the code works but only if the spree team thinks it's useful documentation. If not then no biggie.