# HG changeset patch # User Emile Anclin # Date 1238581501 -7200 # Node ID 79c1abc643043ba8cfcc8b7fcf7ef0e6ca14b79c # Parent e224f064a2680aa6fc4f11991760e1067044a091 doc improvements diff -r e224f064a268 -r 79c1abc64304 doc/book/en/B0040-migration.en.txt --- a/doc/book/en/B0040-migration.en.txt Tue Mar 31 17:09:38 2009 +0200 +++ b/doc/book/en/B0040-migration.en.txt Wed Apr 01 12:25:01 2009 +0200 @@ -44,8 +44,8 @@ (schema and data migration for example). Again in the directory `migration`, the file `depends.map` allows to indicate -that to migrate to a particular model version, you always have to first migrate -to a particular `CubicWeb` version. This file can contain comments (lines +that for the migration to a particular model version, you always have to first +migrate to a particular `CubicWeb` version. This file can contain comments (lines starting by `#`) and a dependancy is listed as follows: :: : @@ -60,12 +60,12 @@ Base context ------------ -The following identifiers are pre-defined in the migration scripts: +The following identifiers are pre-defined in migration scripts: * `config`, instance configuration * `interactive_mode`, boolean indicating that the script is executed in - an intercative mode or not + an interactive mode or not * `appltemplversion`, application model version of the instance @@ -73,7 +73,7 @@ * `cubicwebversion`, installed cubicweb version -* `confirm(question)`, function interrogating the user and returning true +* `confirm(question)`, function asking the user and returning true if the user answers yes, false otherwise (always returns true in non-interactive mode) @@ -98,7 +98,7 @@ Schema migration ---------------- -The following functions for schema migration are available in the `repository` +The following functions for schema migration are available in `repository` scripts: * `add_attribute(etype, attrname, attrtype=None, commit=True)`, adds a new @@ -148,7 +148,7 @@ or even relations definitions). * `change_relation_props(subjtype, rtype, objtype, commit=True, **kwargs)`, changes - properties of a relation definition by using the nammed parameters of the properties + properties of a relation definition by using the named parameters of the properties to change. * `set_widget(etype, rtype, widget, commit=True)`, changes the widget used for the @@ -159,19 +159,19 @@ Data migration -------------- -The following functions for data migration are available in the `repository` scripts: +The following functions for data migration are available in `repository` scripts: * `rql(rql, kwargs=None, cachekey=None, ask_confirm=True)`, executes an arbitrary RQL query, either to interrogate or update. A result set object is returned. * `add_entity(etype, *args, **kwargs)`, adds a nes entity type of the given - type. The attributes and relations values are specified using the nammed and + type. The attribute and relation values are specified using the named and positionned parameters. Workflow creation ----------------- -The following functions for workflow creation are available in the `repository` +The following functions for workflow creation are available in `repository` scripts: * `add_state(name, stateof, initial=False, commit=False, **kwargs)`, adds a new state @@ -185,10 +185,10 @@ Configuration migration ----------------------- -The following functions for configuration migration are available in all the +The following functions for configuration migration are available in all scripts: -* `option_renamed(oldname, newname)`, indicates that an option has been renammed +* `option_renamed(oldname, newname)`, indicates that an option has been renamed * `option_group_change(option, oldgroup, newgroup)`, indicates that an option does not belong anymore to the same group. @@ -202,7 +202,7 @@ -------------------------- Those functions are only used for low level operations that could not be accomplished otherwise or to repair damaged databases during interactive -session. They are available in the `repository` scripts: +session. They are available in `repository` scripts: * `sqlexec(sql, args=None, ask_confirm=True)`, executes an arbitrary SQL query * `add_entity_type_table(etype, commit=True)` diff -r e224f064a268 -r 79c1abc64304 doc/book/en/C011-installation.en.txt --- a/doc/book/en/C011-installation.en.txt Tue Mar 31 17:09:38 2009 +0200 +++ b/doc/book/en/C011-installation.en.txt Wed Apr 01 12:25:01 2009 +0200 @@ -29,7 +29,7 @@ deb http://ftp.logilab.org/dists/ hardy/ -You can now install the required packages with the following command: :: +You can now install the required packages with the following command:: apt-get update apt-get install cubicweb @@ -41,7 +41,7 @@ Install from source ``````````````````` -You can download the archive containing the sources from our `ftp site`_ at: :: +You can download the archive containing the sources from our `ftp site`_ at:: http://ftp.logilab.org/pub/cubicweb/ @@ -92,8 +92,8 @@ Your new cubes will be placed in `/usr/share/cubicweb/cubes` and your applications will be placed in `/etc/cubicweb.d`. -To use others directories then you will have to configure the -following environment variables as follows: :: +To use other directories you will have to configure the +following environment variables as follows:: export CW_CUBES_PATH=~/lib/cubes export CW_REGISTRY=~/etc/cubicweb.d/ @@ -120,7 +120,7 @@ $ initdb -D /path/to/pgsql Once initialized, you can launch the database server Postgres - with the command: :: + with the command:: $ postgres -D /path/to/psql @@ -130,20 +130,20 @@ $ chown username /path/to/pgsql -* Create a superuser for `CubicWeb` instance: :: +* Create a superuser for `CubicWeb` instance:: $ su $ su - postgres $ createuser -s username Initialize the password of the superuser you just created for your - database: :: + database:: $ su $ su - postgres $ psql - And then execute de following query: :: + And then execute de following query:: ALTER USER username WITH PASSWORD `password`