Split existing configuration guide #2488
Conversation
| Solidus extensions can be installed in a few simple steps: | ||
|
|
||
| 1. Add the extension gem to your project's `Gemfile`. | ||
| 2. Run `bundle install to install the gem and its dependencies. |
There was a problem hiding this comment.
I think you are missing an ending ` for bundle install.
benjaminwil
force-pushed
the
split_configuration_guide
branch
2 times, most recently
from
a4f1405 to
79fdb90
Compare
benjaminwil
force-pushed
the
split_configuration_guide
branch
from
3fb863e to
c8acd33
Compare
benjaminwil
force-pushed
the
split_configuration_guide
branch
from
c8acd33 to
b153cef
Compare
| gem 'solidus', git: 'https://github.com/my_account/solidus.git', branch: "my-new-feature" | ||
| ``` | ||
|
|
||
| If you think your feature (or fix) if of interest to the wider Solidus |
| @@ -0,0 +1,23 @@ | |||
| # Private Solidus fork | |||
There was a problem hiding this comment.
It might be a little bit misleading to use the word "private" here. It has a specific connotation when associated to a GitHub fork. (Technically, there's considerably more work involved in making a private fork of Solidus, since making a private fork of a public repo isn't functionality GitHub provides.)
|
|
||
| ## Define new preferences | ||
|
|
||
| You can define preferences for a model within the model itself: |
There was a problem hiding this comment.
We should probably mention that a column needs to be added to the model to persist the preferences.
class MyMigration < ActiveRecord::Migration[5.0]
def change
add_column :my_table, :preferences, :text
end
end| # App configuration | ||
|
|
||
| Solidus includes many preferences with default settings that are appropriate for | ||
| typical stores. For a list of Solidus's preferences their default values, see |
There was a problem hiding this comment.
Solidus's preferences and their default values . . .
|
Thanks for the review @adammathys. I've committed changes for all your comments. If you could approve that would be great. 👍 |
After speaking with jhawthorne about it, it seemed right to mention that we do not support extending the `Spree::AppConfiguration` object, and encourage developers to try using new model preferences to get the functionality they desire. (Although that may not always help them.)
Thanks to adammathys for his review of this content.
benjaminwil
force-pushed
the
split_configuration_guide
branch
from
f95a6b6 to
5d4cdc2
Compare
I've cleaned up and rewritten some of the existing configuration guide. More noticeably, I've split the existing guide up into a number of new articles that now reside in different subdirectories.
getting-starteddirectory now has a stub about why you might want to create a private Solidus fork.extensionsdirectory houses an article about installing extensions and (for now) an article about decorators (though I think this needs another home).viewsdirectory has an article about overriding views.preferencesdirectory has articles about site-wide preferences configuration, class extension points, and creating model-specific preferences.None of this is entirely new content, but used to all live together in one article. Splitting things up into more focused directories will hopefully help developers find the information they need faster as the Solidus documentation continues to grow.
This is part a larger project to improve Solidus's documentation. See this gist with the high-level table of contents. Where and how this documentation will exist is still up for discussion.