Skip to content

Commit

Permalink
Rename all guides.
Browse files Browse the repository at this point in the history
  • Loading branch information
robyurkowski authored and parndt committed Mar 27, 2012
1 parent f55f4f5 commit 88ce641
Show file tree
Hide file tree
Showing 26 changed files with 38 additions and 38 deletions.
@@ -1,4 +1,4 @@
h2. Installing Refinery Prerequisites
h2. Installation Prerequisites

This guide covers getting your system ready for Refinery. Afterwards you will have:

Expand Down
4 changes: 2 additions & 2 deletions doc/guides/1 - Getting Started/2 - Getting Started.textile
@@ -1,4 +1,4 @@
h2. Getting Started with Refinery
h2. Getting Started

This guide covers getting up and running with Refinery CMS. After reading it, you should be familiar with:

Expand All @@ -16,7 +16,7 @@ This guide is designed for beginners who want to get started with a Refinery CMS

* The "Ruby":http://www.ruby-lang.org/en/downloads language version 1.8.7 or higher (1.9.3 recommended)

TIP: Ruby 1.9.1 is not usable because Rails 3.x is not compatible with it. Use 1.9.3 for smooth sailing.
TIP: Do not use Ruby 1.9.1 as Rails 3.x is not compatible with it. Use 1.9.3 for smooth sailing.

* The "RubyGems":http://rubyforge.org/frs/?group_id=126 packaging system
* A working installation of the "SQLite3 Database":http://www.sqlite.org
Expand Down
2 changes: 1 addition & 1 deletion doc/guides/1 - Getting Started/3 - How to get help.textile
@@ -1,4 +1,4 @@
h2. How to get help with Refinery
h2. How to get help

We all sometimes hit a brick wall. This guide will show you how to:

Expand Down
@@ -1,4 +1,4 @@
h2. How to change Page Parts
h2. Changing Page Parts

Refinery sets up two default page parts +Body+ and +Side Body+. Sometimes this is not suitable for your project. This guide will show you how to:

Expand Down
@@ -1,4 +1,4 @@
h2. Titles and URLs in Refinery Pages
h2. Page Titles and URLs

This guide covers titles and urls in Refinery Pages. After reading it, you should be familiar with:

Expand Down
@@ -1,4 +1,4 @@
h2. How to override a view
h2. Overriding views

The default HTML Refinery generates on the front end is sometimes not suitable for your design. This guide will show you how to:

Expand Down
@@ -1,4 +1,4 @@
h2. Extending Controllers and Model with Decorators
h2. Extending Controllers and Models with Decorators

The default behavior of Refinery or a Refinery extension and its controllers and models may not be exactly what you are looking for. This guide will show you how to:

Expand Down
@@ -1,4 +1,4 @@
h2. How to override JavaScripts
h2. Overriding javascripts

Refinery by default will provide you with the required javascript files you need. Sometimes you want to provide your own files and this guide will show you how to:

Expand Down
4 changes: 2 additions & 2 deletions doc/guides/2 - Refinery Basics/6 - Google Analytics.textile
@@ -1,4 +1,4 @@
h2. How to setup Google Analytics
h2. Google Analytics

Google Analytics is a great free way to find out how much traffic your site is getting. This guide will show you how to:

Expand All @@ -8,4 +8,4 @@ endprologue.

Default Refinery layouts have Google Analytics support built in. To start using Google Analytics on your site all you need to do is go into the "Settings" area and edit the setting called "Analytics Page Code". Replace "UA-XXXXXX-X" with your Google Analytics code to get up and running.

Note that this setting only appears in production. So you won't see this setting in your development environment.
Note that this setting only appears in production. So you won't see this setting in your development environment.
@@ -1,4 +1,4 @@
h2. Translate Refinery into your language
h2. Translate Refinery

Refinery supports translations. This guide will show you how to:

Expand Down
@@ -1,4 +1,4 @@
h2. How to add an image gallery to pages
h2. Adding an Image Gallery to Pages

By default pages don't allow you to make galleries of images. This guide will show you how to:

Expand Down Expand Up @@ -150,4 +150,4 @@ map.namespace(:admin, :path_prefix => 'refinery') do |admin|
end
</ruby>

Now you should be able to bind portfolio entries on every single page and preview images on select action.
Now you should be able to bind portfolio entries on every single page and preview images on select action.
@@ -1,4 +1,4 @@
h2. How to redirect old pages
h2. Redirecting Legacy URLs

Many Refinery sites replace old ones that have links to these older pages. This guide will show you how to:

Expand Down Expand Up @@ -47,4 +47,4 @@ end

Restart your server and you're done.

TIP: To better understand the DSL of Rack::Rewrite, check out the "documentation":https://github.com/jtrupiano/rack-rewrite, or "read":http://blog.smartlogicsolutions.com/2009/11/24/rack-rewrite-google-analytics-makes-site-transitions-seamless/ how the author of the middleware used it in conjuction with Google
TIP: To better understand the DSL of Rack::Rewrite, check out the "documentation":https://github.com/jtrupiano/rack-rewrite, or "read":http://blog.smartlogicsolutions.com/2009/11/24/rack-rewrite-google-analytics-makes-site-transitions-seamless/ how the author of the middleware used it in conjuction with Google
@@ -1,4 +1,4 @@
h2. Tabbed fields in your extension's admin area
h2. Tabbed Fields

Sometimes you create an extension with a number of wymeditor fields. Having these display one after another can be overwhelming for your clients (or you!).
This guide will show you how to:
Expand Down
@@ -1,8 +1,8 @@
h2. Creating Multiple Data-Tables in a Single Engine
h2. Multiple Resources in an Extension

This guide will show you how to:

* Creating multiple tables on one single extension
* Create multiple tables on one single extension

endprologue.

Expand Down
2 changes: 1 addition & 1 deletion doc/guides/4 - Refinery Extensions/3 - Testing.textile
@@ -1,4 +1,4 @@
h2. How to test your extension
h2. Testing your Extension

Refinery ships with an optional testing extension in the form of a gem called +refinerycms-testing+ which will add generators and rake tasks to your extension that provide it with the same RSpec2 testing environment we use to test Refinery. We abstract common test helpers, controller macros, and factories into this extension so you can use these in tests of your own.

Expand Down
4 changes: 2 additions & 2 deletions doc/guides/4 - Refinery Extensions/4 - Pretty URLs.textile
@@ -1,4 +1,4 @@
h2. Marketable URLs for Engines
h2. Pretty / SEO-Friendly URLs

It's very important for Search Engine Optimization (SEO) purposes to have your URLs be human-readable. Refinery CMS ships with software (FriendlyID) that enables these marketing-friendly URLs with only minor modifications.

Expand Down Expand Up @@ -57,4 +57,4 @@ Each entry must be re-saved to generate its slug. You can do this quickly from t
StaffMember.all.map(&:save)
</ruby>

If all entries in the resulting array return true, everything is complete! If you have an entry return false, you may have some individual issues that prevent saving, and you can update these manually using the Refinery CMS administrative interface.
If all entries in the resulting array return true, everything is complete! If you have an entry return false, you may have some individual issues that prevent saving, and you can update these manually using the Refinery CMS administrative interface.
@@ -1,4 +1,4 @@
h2. Attaching Refinery CMS to an existing Rails application
h2. Using Refinery with an Existing Rails App

This guide covers integration with Refinery CMS. After reading it, you should be familiar with:

Expand Down
@@ -1,4 +1,4 @@
h2. Attaching Refinery CMS To A Larger Rails + Devise Application
h2. Using Refinery with Rails 3.1 and Devise

This guide covers adding functionality provided by Refinery CMS to an existing application, while retaining the existing application's control over configuration and use of the Devise authentication gem. After reading it, you should be familiar with:

Expand Down
@@ -1,4 +1,4 @@
h2. Attaching Refinery CMS To A Larger Rails + Devise Application
h2. Using Refinery with Rails and Devise

This guide covers adding functionality provided by Refinery CMS to an existing application, while retaining the existing application's control over configuration and use of the Devise authentication gem. After reading it, you should be familiar with:

Expand Down Expand Up @@ -495,4 +495,4 @@ module ExistingApp

</ruby>

Now when you update your refinery gems, your ExistingApp business rules are still in place.
Now when you update your refinery gems, your ExistingApp business rules are still in place.
@@ -1,4 +1,4 @@
h2. How to update Refinery to the latest stable version
h2. Upgrading to the Latest Stable Version

Refinery constantly changes as we add new features and fix bugs. This guide will show you how to:

Expand Down
@@ -1,4 +1,4 @@
h2. How to upgrade to edge Refinery
h2. Upgrading to Edge

If you're an experienced Refinery developer you might want to live on the edge. This guide will show you how to:

Expand Down Expand Up @@ -40,4 +40,4 @@ $ bundle exec rails generate refinery:cms --update

h3. Solve any deprecation problems.

Look at your log when running you app to make sure nothing has been deprecated. If there are some, fix the issues.
Look at your log when running you app to make sure nothing has been deprecated. If there are some, fix the issues.
4 changes: 2 additions & 2 deletions doc/guides/7 - Hosting and Deployment/1 - Heroku.textile
@@ -1,4 +1,4 @@
h2. How to Install Refinery on Heroku
h2. Heroku

"Heroku":http://heroku.com is a popular hosting choice for many developers. This guide will show you how to:

Expand Down Expand Up @@ -86,4 +86,4 @@ h4. Other problems?
See the "How to use Amazon S3 for storage":http://refinerycms.com/guides/how-to-use-amazon-s3-for-storage guide for more specific information.

Otherwise, run `heroku logs` or `heroku logs --tail` and see if you can spot the error yourself.
Or you could explore the "help options available":/guides/how-to-get-help-with-refinery.
Or you could explore the "help options available":/guides/how-to-get-help-with-refinery.
@@ -1,4 +1,4 @@
h2. How to use Amazon S3 for storage
h2. Using Amazon S3 for Uploads

Hosting your site's files on Amazon S3 is a popular option for many, especially
if you're using a read only file system like "Heroku":http://heroku.com.
Expand Down
@@ -1,4 +1,4 @@
h2. How to use Full Page Caching with Apache
h2. Full-Page Cache with Apache

If you have a simple Page on a slow Server with Apache you can use the Full
Page Caching for deliver the most pages directly from Apache (without passenger).
Expand Down Expand Up @@ -46,4 +46,4 @@ ExpiresByType application/javascript "access plus 1 year"
AddOutputFilterByType DEFLATE text/html text/plain text/xml text/javascript text/css application/javascript
</code>

Now pages are delivered by Apache without touching passenger.
Now pages are delivered by Apache without touching passenger.
@@ -1,4 +1,4 @@
h2. How to contribute to Refinery development
h2. Contributing to Refinery

One of Refinery's key principles is encouraging people to contribute. This guide will show you how to:

Expand Down Expand Up @@ -80,4 +80,4 @@ Some of the effort that goes into Refinery CMS is covered by client work where r

If you would like to contribute to Refinery CMS development by helping us to justify spending more time on it then you can "donate to the project at pledgie.":http://pledgie.com/campaigns/8431

All donations are very much appreciated and 100% of proceeds go toward making Refinery CMS even better.
All donations are very much appreciated and 100% of proceeds go toward making Refinery CMS even better.
@@ -1,4 +1,4 @@
h2. Writing a guide for this website
h2. Writing a Guide for this Website

This guide covers writing your own guide. After reading it, you should be able to:

Expand Down Expand Up @@ -35,4 +35,4 @@ The majority of Refinery CMS remains undocumented as development happens quickly
* You will be listed as a contributor at "github":https://github.com/resolve/refinerycms/contributors
* All contributors receive special status in the "IRC Channel":irc://irc.freenode.net/refinerycms
* Help others who face the same issues
* Reduce the amount of time the core team spends on support so they can focus on making Refinery even better
* Reduce the amount of time the core team spends on support so they can focus on making Refinery even better

0 comments on commit 88ce641

Please sign in to comment.