Permalink
Browse files

Convert textile guides files to markdown

  • Loading branch information...
bricesanchez committed Sep 20, 2015
1 parent 9794cd8 commit 798cf3a982a15f211a9e59066fed9bf679a4eedb
Showing with 2,839 additions and 3,453 deletions.
  1. +112 −0 doc/guides/1 - Getting Started/1 - Installation Prerequisites.md
  2. +0 −98 doc/guides/1 - Getting Started/1 - Installation Prerequisites.textile
  3. +299 −0 doc/guides/1 - Getting Started/2 - Getting Started.md
  4. +0 −314 doc/guides/1 - Getting Started/2 - Getting Started.textile
  5. +227 −0 doc/guides/1 - Getting Started/3 - Generate an Extension to Use Your MVCs.md
  6. +0 −228 doc/guides/1 - Getting Started/3 - Generate an Extension to Use Your MVCs.textile
  7. +25 −0 doc/guides/1 - Getting Started/4 - How to get help.md
  8. +0 −36 doc/guides/1 - Getting Started/4 - How to get help.textile
  9. +91 −0 doc/guides/1 - Getting Started/5 - Best Practices and Frequently Asked Questions.md
  10. +0 −117 doc/guides/1 - Getting Started/5 - Best Practices and Frequently Asked Questions.textile
  11. +54 −0 doc/guides/2 - Refinery Basics/1 - Changing Page Parts.md
  12. +0 −75 doc/guides/2 - Refinery Basics/1 - Changing Page Parts.textile
  13. +9 −12 doc/guides/2 - Refinery Basics/{2 - Page Titles and URLs.textile → 2 - Page Titles and URLs.md}
  14. +14 −16 doc/guides/2 - Refinery Basics/{3 - Overriding views.textile → 3 - Overriding views.md}
  15. +59 −0 doc/guides/2 - Refinery Basics/4 - Extending Controllers with Decorators.md
  16. +0 −61 doc/guides/2 - Refinery Basics/4 - Extending Controllers with Decorators.textile
  17. +33 −0 doc/guides/2 - Refinery Basics/5 - Overriding javascripts.md
  18. +0 −44 doc/guides/2 - Refinery Basics/5 - Overriding javascripts.textile
  19. +4 −6 doc/guides/2 - Refinery Basics/{6 - Google Analytics.textile → 6 - Google Analytics.md}
  20. +39 −40 doc/guides/2 - Refinery Basics/{7 - Translate Refinery.textile → 7 - Translate Refinery.md}
  21. +49 −46 doc/guides/2 - Refinery Basics/{8 - Extending Models.textile → 8 - Extending Models.md}
  22. +23 −0 doc/guides/2 - Refinery Basics/9 - Resources.md
  23. +0 −26 doc/guides/2 - Refinery Basics/9 - Resources.textile
  24. +118 −0 doc/guides/3 - Advanced Techniques and Tips/1 - Using Custom View or Layout Templates.md
  25. +0 −169 doc/guides/3 - Advanced Techniques and Tips/1 - Using Custom View or Layout Templates.textile
  26. +60 −0 doc/guides/3 - Advanced Techniques and Tips/2 - Troubeshooting Image Problems.md
  27. +0 −62 doc/guides/3 - Advanced Techniques and Tips/2 - Troubeshooting Image Problems.textile
  28. +47 −33 ...3 - Advanced Techniques and Tips/{3 - Changing Menu Markup.textile → 3 - Changing Menu Markup.md}
  29. +21 −0 doc/guides/4 - Refinery Extensions/1 - Tabbed Fields.md
  30. +0 −23 doc/guides/4 - Refinery Extensions/1 - Tabbed Fields.textile
  31. +10 −9 ...nsions/10 - Using a Refinery CMS extension as a standalone extension in your Rails Application.md
  32. +0 −41 ...s/10 - Using a Refinery CMS extension as a standalone extension in your Rails Application.textile
  33. +241 −0 doc/guides/4 - Refinery Extensions/2 - Multiple Resources in an Extension.md
  34. +0 −237 doc/guides/4 - Refinery Extensions/2 - Multiple Resources in an Extension.textile
  35. +25 −34 doc/guides/4 - Refinery Extensions/{3 - Testing.textile → 3 - Testing.md}
  36. +65 −0 doc/guides/4 - Refinery Extensions/4 - Pretty URLs.md
  37. +0 −66 doc/guides/4 - Refinery Extensions/4 - Pretty URLs.textile
  38. +246 −0 doc/guides/4 - Refinery Extensions/5 - Relating Resources in an Extension.md
  39. +0 −259 doc/guides/4 - Refinery Extensions/5 - Relating Resources in an Extension.textile
  40. +24 −0 doc/guides/4 - Refinery Extensions/6 - Generate a custom form.md
  41. +0 −23 doc/guides/4 - Refinery Extensions/6 - Generate a custom form.textile
  42. +70 −0 doc/guides/4 - Refinery Extensions/7 - Changes to extensions in Refinery 3.0.md
  43. +0 −74 doc/guides/4 - Refinery Extensions/7 - changes to extensions in Refinery 3.0.textile
  44. +0 −118 doc/guides/4 - Refinery Extensions/8 - Using icons
  45. +113 −0 doc/guides/4 - Refinery Extensions/8 - Using icons.md
  46. +108 −91 ...guides/4 - Refinery Extensions/9 - Adding an image collection to an extension using PageImages.md
  47. +0 −223 ...s/4 - Refinery Extensions/9 - Adding an image collection to an extension using PageImages.textile
  48. +73 −0 doc/guides/5 - Using Refinery as an Engine/1 - With an existing Rails app.md
  49. +0 −77 doc/guides/5 - Using Refinery as an Engine/1 - With an existing Rails app.textile
  50. +42 −0 doc/guides/6 - Updating Refinery/1 - Upgrading to the Latest Stable Version.md
  51. +0 −44 doc/guides/6 - Updating Refinery/1 - Upgrading to the Latest Stable Version.textile
  52. +12 −14 doc/guides/6 - Updating Refinery/{2 - Upgrading to Edge.textile → 2 - Upgrading to Edge.md}
  53. +77 −61 doc/guides/6 - Updating Refinery/3 - Upgrading to Refinery 3.0.md
  54. +0 −147 doc/guides/6 - Updating Refinery/3 - Upgrading to Refinery 3.0.textile
  55. +161 −0 doc/guides/7 - Hosting and Deployment/1 - Heroku.md
  56. +0 −235 doc/guides/7 - Hosting and Deployment/1 - Heroku.textile
  57. +83 −0 doc/guides/7 - Hosting and Deployment/2 - Amazon S3 for Uploads.md
  58. +0 −86 doc/guides/7 - Hosting and Deployment/2 - Amazon S3 for Uploads.textile
  59. +20 −23 ...ing and Deployment/{3 - Full-Page Cache with Apache.textile → 3 - Full-Page Cache with Apache.md}
  60. +87 −0 doc/guides/8 - Contributing/1 - Contributing to Refinery.md
  61. +0 −87 doc/guides/8 - Contributing/1 - Contributing to Refinery.textile
  62. +37 −0 doc/guides/8 - Contributing/2 - Writing a guide for this website.md
  63. +0 −39 doc/guides/8 - Contributing/2 - Writing a guide for this website.textile
  64. +61 −59 doc/guides/9 - Presenters/{1 - Menu Presenter.textile → 1 - Menu Presenter.md}
@@ -0,0 +1,112 @@
# Installation Prerequisites
This guide covers getting your system ready for Refinery. Afterwards you will have:
* A working version of Ruby
* ImageMagick installed
* Either the SQLite, MySQL, or PostgreSQL database configured
## Checklist
If you are already a Rails developer, you will most likely not have to install anything else. Here's the requirements for Refinery:
* __Ruby__ - 2.2.2+, Rubinius, and JRuby are all acceptable
* __RubyGems__ - Recommended that you have the latest version installed
* __Database__ - SQLite3 (default), MySQL, or PostgreSQL
* __ImageMagick__ - Recommended that you have the latest version installed
If you have all of these things, great! Proceed on to the [Getting Started with Refinery](/guides/getting-started/) guide.
Otherwise, choose your operating system below.
## Ubuntu
### Ruby
__TIP__: The best way to install Ruby is using [rbenv](https://github.com/rbenv/rbenv)
```shell
$ sudo apt-get install ruby
```
### RubyGems
__TIP__: If you used `rbenv` above then this step will not be necessary.
```shell
$ sudo apt-get install rubygems
```
### Database
For SQLite:
```shell
$ sudo apt-get install sqlite3 libsqlite3-dev
```
For MySQL:
```shell
$ sudo apt-get install mysql-client mysql-server libmysqlclient-dev
```
### ImageMagick
```shell
$ sudo apt-get install imagemagick
```
## Mac OS X
### Ruby
__TIP__: The best way to install Ruby is using [rbenv](https://github.com/rbenv/rbenv)
### Rubygems
__TIP__: If you used `rbenv` above then this step will not be necessary.
Rubygems also comes installed by default, however, it could be an old version which will cause problems. Update using:
```shell
$ gem update --system
```
Also, in the past, we face to a RDoc bug, you should update it as well:
```shell
$ gem install rdoc
```
### Database
SQLite is most likely already installed.
### ImageMagick
Use this shell script: <https://github.com/maddox/magick-installer>. Or, if you have [Homebrew](http://mxcl.github.io/homebrew/) installed, you can use:
```shell
$ brew install imagemagick
```
## Windows
### Ruby and Rubygems
<http://www.railsinstaller.org/> provides a great installer to get you up and running in no time. Just download the kit and follow through the installer.
### Database
If you used Rails Installer, then SQLite will have been installed by default. For MySQL, follow the instructions at the MySQL website: <http://www.mysql.com/downloads/mysql/>
### ImageMagick
__WARNING__: ImageMagick is tricky to install on Windows. Make sure to read the instructions carefully, and if one version does not work for you try an older version as well.
Follow the instructions at <http://www.imagemagick.org/script/binary-releases.php#windows>
## Ready to Install!
Easier than expected right? Now you're ready to start building great websites with Refinery! Proceed on to the [Getting Started with Refinery](/guides/getting-started/) guide.

This file was deleted.

Oops, something went wrong.
Oops, something went wrong.

0 comments on commit 798cf3a

Please sign in to comment.