Skip to content

Commit

Permalink
Update the docs and add helpful notes.
Browse files Browse the repository at this point in the history
Fixes #2577
  • Loading branch information
parndt committed Jul 29, 2014
1 parent 26d514d commit 6931195
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 36 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ In the case of a controller method, you can get easy access to the code with
the +refinery:uncrudify+ rake task:

<shell>
$ rake refinery:uncrudify controller=refinery/admin/pages action=create
$ bundle exec rake refinery:uncrudify controller=refinery/admin/pages action=create
</shell>

TIP. Running the +rake refinery:uncrudify+ task outputs to +stdout+, and will not modify any files, so you can do so without fear of overwriting your existing controller modifications.
Expand Down Expand Up @@ -92,7 +92,7 @@ then you should be in the clear.

h4. How do I hide the page title?

"Phil":http://philiparndt.name, one of the chief maintainers of Refinery CMS, says:
"Phil":http://p.arndt.io, one of the chief maintainers of Refinery CMS, says:

bq. Add a +content_for :body_content_title+ block in the template you're including from. Just make it blank and tell the +_content_page+ partial to hide empty sections by passing it +:locals => {:hide_sections => [:body_content_title]}+.

Expand All @@ -112,5 +112,5 @@ In Refinery 1.0.x, you have have two choices. The more severe one is to reset al
slugs for that model:

<shell>
MODEL=news_item rake friendly_id:redo_slugs
MODEL=news_item bundle exec rake friendly_id:redo_slugs
</shell>
4 changes: 2 additions & 2 deletions doc/guides/2 - Refinery Basics/7 - Translate Refinery.textile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ endprologue.

h3. Setup

Before you start translating, you should clone a fresh copy of Refinery from GitHub. See "this guide":/guides/contributing-to-refinery for information how to do that.
Before you start translating, you should clone a fresh copy of Refinery from GitHub. See "the contributing guide":/guides/contributing-to-refinery for information regarding how to do that.

It's not required, but we strongly advise you to create a separate branch when adding a translation or a new feature. You can do so by typing the following shell command.

Expand Down Expand Up @@ -106,4 +106,4 @@ h3. Pull request

h3. Done

And now you're done! If your changes are accepted, you will end up on the "contributor list":http://github.com/refinery/refinerycms/contributors.
And now you're done! If your changes are accepted, you will end up on the "contributor list":https://github.com/refinery/refinerycms/contributors.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ endprologue.

WARNING. This guide assumes that you will be upgrading from version 2.0.10 of Refinery CMS. If your application is not up-to-date we strongly recommend that you upgrade it to version 2.0.10 before trying to upgrade to version 2.1.0.

WARNING. Before continuing make sure you have a backup copy of your application and database in case something goes wrong.
WARNING. Before continuing, make sure you have a backup copy of your application and database in case something goes wrong.

h3. Updating gems

Expand Down Expand Up @@ -36,9 +36,11 @@ This command will do a couple of things:
* Update +app/views/sitemap/index.xml.builder+ template.
* Wrap +config.action_mailer+ config entry in a conditional +if config.respond_to?(:action_mailer)+ clause for each environment file located in +app/config/environments+.
* Copy new migrations.
* Run +rake db:migrate+ and +rake db:seed+ commands.
* Run +bundle exec rake db:migrate+ and +bundle exec rake db:seed+ commands.

NOTE: If you don't want the generator to run +rake db:migrate+ and +rake db:seed+ commands pass the +--skip_db+ option when invoking refinery:cms generator:
NOTE: Please check that the command has put refinery/formatting and refinery/theme into your CSS manifest file, as per the following "issue on GitHub":https://github.com/refinery/refinerycms/issues/2577

NOTE: If you don't want the generator to run +bundle exec rake db:migrate+ and +bundle exec rake db:seed+ commands pass the +--skip_db+ option when invoking refinery:cms generator:

<shell>
rails generate refinery:cms --skip_db
Expand All @@ -60,6 +62,6 @@ What this will do is check if the +seo_meta+ table has an index named +index_seo
* Remove the +meta_keywords+ column.
* Add back the original index but with a shorter name.

Now run +rake db:migrate+.
Now run +bundle exec rake db:migrate+.

h3. Profit!
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,31 @@ Refinery constantly changes as we add new features and fix bugs. This guide will

endprologue.

WARNING. Check out this post "http://www.refinerycms.com/blog/whats-new-in-refinery-cms-099":http://www.refinerycms.com/blog/whats-new-in-refinery-cms-099 to see how to upgrade to 0.9.9 from 0.9.8.9. You can't update from 0.9.8.9 to anything later than 0.9.9 without going to 0.9.9 first.

h3. Introduction

First you need a current installation of Refinery. Refinery would have been installed by one of two ways, Ruby Gem or Git. When updating, the latest files are copied into your project.
First, you need a current installation of Refinery. Refinery would have been installed by one of two ways, Rubygem or Git. When updating, the latest files are copied into your project.

h3. Updating a Gem Installation of Refinery

Take a look at "http://rubygems.org/gems/refinerycms":http://rubygems.org/gems/refinerycms to find the latest version number for Refinery.
Take a look at "https://rubygems.org/gems/refinerycms":https://rubygems.org/gems/refinerycms to find the latest version number for Refinery.

Edit your +Gemfile+ to reference the latest version of Refinery (a later version than the one shown "may exist":https://rubygems.org/gems/refinerycms/versions).

<ruby>
gem 'refinerycms', '= 2.1.1'
gem 'refinerycms', '~> 2.1.2'
</ruby>

Now install the new gems using bundler ('bundle install' is outdated):
Now install the new gems using bundler's update functionality:

<shell>
$ bundle update
$ bundle update refinerycms
</shell>

Use the rails generator to update your Refinery installation:
Inside the application's directory, use the Rails generator to update your Refinery installation:

TIP: You only need to run the below step when upgrading between major or minor versions. Bug fix releases should not change the database structure. For example, if you are going from 1.0.3 -> 1.0.8 (Bugfix) you do not need to run this command.

TIP: You only need to run the below step when upgrading between major or minor versions. Bug fix releases should not change the database structure. For example, if you are going from 1.0.3 -> 1.0.8 (Bugfix) you do not need to run this command.
WARNING: This will overwrite files so make sure you have a backup or have your current code committed to a remote git repository.

<shell>
$ rails generate refinery:cms --update
Expand All @@ -39,6 +39,6 @@ $ rails generate refinery:cms --update
Database migrations and new gem dependencies may have been added, so finish your Refinery update with:

<shell>
$ rake db:migrate
$ bundle exec rake db:migrate
$ bundle install
</shell>
12 changes: 2 additions & 10 deletions doc/guides/6 - Updating Refinery/4 - Upgrading to Edge.textile
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,6 @@ WARNING: This tutorial is only for advanced Refinery users who are used to conti

Here are the basic steps:

h3. Clone Refinery

First clone the git source in order to get the newest app generator.

<shell>
$ git clone git://github.com/refinery/refinerycms.git ~/refinerycms-edge
</shell>

h3. Upgrade your current application

Replace the line that looks like this:
Expand All @@ -29,10 +21,10 @@ gem 'refinerycms'
With a line that looks like this:

<ruby>
gem 'refinerycms', :path => '~/refinerycms-edge'
gem 'refinerycms', :git => 'https://github.com/refinery/refinerycms'
</ruby>

Now use the refinerycms generator to update your application:
Now, inside the application's directory, use the refinerycms generator to update your application:

<shell>
$ bundle exec rails generate refinery:cms --update
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ h4. Setup

h5. In your browser

* Login to "http://github.com":http://github.com
* Go to "http://github.com/refinery/refinerycms":http://github.com/refinery/refinerycms
* Login to "https://github.com":https://github.com
* Go to "https://github.com/refinery/refinerycms":https://github.com/refinery/refinerycms
* If you have a fork of refinerycms already, delete it (_if you're not going to lose work. This makes it much easier for us to integrate your changes back in_)
* Click on "fork" to make a fresh new fork on your own account.

Expand All @@ -43,7 +43,7 @@ h5. In your browser

h4. I found an issue. Where do I file it?

* add it to "http://github.com/refinery/refinerycms/issues":http://github.com/refinery/refinerycms/issues - with as much detail as possible :-)
* add it to "https://github.com/refinery/refinerycms/issues":https://github.com/refinery/refinerycms/issues - with as much detail as possible :-)

h4. Contributing a fix

Expand All @@ -69,7 +69,7 @@ TIP: if you've filed an issue on Github add "Closes GH-999" (replace 999 with yo
$ git push origin master
</shell>

Now go to "http://github.com/refinery/refinerycms":http://github.com/refinery/refinerycms and click "Pull Request". Type a nice message explaining what you've done and send the request.
Now go to "https://github.com/refinery/refinerycms":https://github.com/refinery/refinerycms and click "Pull Request". Type a nice message explaining what you've done and send the request.

We'll merge it in if it's all good.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ You should be able to match the sections of the raw textile guide with the "live

h3. Submitting the guide

* Login to "http://github.com":http://github.com
* Go to "http://github.com/refinery/refinerycms":http://github.com/refinery/refinerycms
* Login to "https://github.com":https://github.com
* Go to "https://github.com/refinery/refinerycms":https://github.com/refinery/refinerycms
* If you have a fork of refinerycms already, delete it (_if you're not going to lose work. This makes it much easier for us to integrate your changes back in_)
* Click on "fork" to make a fresh new fork on your own account.
* Clone your new fork to your local machine

Next make your changes or new guide in the 'doc/guides' folder.

Now go to "http://github.com/refinery/refinerycms":http://github.com/refinery/refinerycms and click "Pull Request".
Now go to "https://github.com/refinery/refinerycms":https://github.com/refinery/refinerycms and click "Pull Request".

After we review it, we'll merge it into the master refinerycms repository, and the changes will be up on http://refinerycms.com/guides within a few seconds.

Expand Down

0 comments on commit 6931195

Please sign in to comment.