Open main menu

Changes

Umlaut Local Configuration Architecture

582 bytes added, 16:20, 19 June 2012
no edit summary
[[Category:Umlaut]]
 
=WARNING: This is Outdated Documentation!!!!=
 
'''THIS IS OUTDATED DOCUMENTATION''' See new Umlaut documentation at http://github.com/team-umlaut/umlaut/wiki
---------
== Principles/Goals: ==
Other locations that are '''NOT yet used''', but would be reasonable extensions of this architecture in the future:
* $Umlaut/app/views/controllers/local* $Umlaut/app/views/models/local
== Rake Tasks to Aid in Management Generation of Local Locations local files ==
Integrating somewhat elegantly with Rails means that your local content There is spread accross several different directories. Umlaut provides some rake tasks a a generator to help you deal create all these locations, and seed them with some sample data - since we want to make it easy to control themin your own SVN, you don't get even these local directory locations from the Umlaut svn.
There is a rake task You may already have run the generator to create all these locations, and seed them with some sample data - since we want to make it easy to control them in your own SVN, you don't get even these local directory locations files from the [Umlaut svn. Change Setup] step, but if not, change into $Umlaut directory and run:
<nowiki>./script/generate umlaut_local</nowiki> Don't worry if you run this twice;it'll warn and prompt you before over-writing any existing files.  == Rake Tasks to Aid in Management of Local Locations == Integrating somewhat elegantly with Rails means that your local content is spread accross several different directories. Umlaut provides some rake umlaut_lcl:generatetasks to help you control them in your own local svn.
:...to both create all directory locations, and especially to put some sample starter files in umlaut_config to help you get started.
:We also provide some rake tasks to perform svn operations on all of these local locations at once.
;rake <nowiki>umlaut_lcl:import_to_svn</nowiki>
:You've generated all this stuff, and added your own local content. Run this to add it all to your own local SVN--or any other SVN you have access to to store your local config. You'll be prompted for an SVN base path. Make sure to run umlaut_lcl:commit too, this operation does not commit any files!
;rake <nowiki>umlaut_lcl:checkout</nowiki>
:Let's say you already have your local files in your own SVN, but now you doing a new Umlaut install for whatever reason. This rake task will pull all your local stuff down en masse and put it into the new install. You will be prompted for an SVN base.
;rake <nowiki>umlaut_lcl:update </nowiki>
:svn update all local directory locations.
;rake <nowiki>umlaut_lcl:commit</nowiki>
:svn commit all local directory locations.
;rake <nowiki>umlaut_lcl:status</nowiki>
:Runs svn status on all local directory locations at once.
 
If you need to create an svn repo on a Linux box it's as easy as:
 
mkdir /home/username/svn
 
svnadmin create /home/username/svn
 
Then you can run the above rake tasks.
== A Locally Customized Layout ==