1.1 --- a/README.txt Sat Sep 17 01:27:01 2011 +0200
1.2 +++ b/README.txt Sun Sep 18 21:37:22 2011 +0200
1.3 @@ -7,6 +7,15 @@
1.4 create and initialise new Wiki instances, install extensions, themes and
1.5 related resources, and perform certain configuration changes.
1.6
1.7 +Important Notices
1.8 +-----------------
1.9 +
1.10 +Release 0.3 of moinsetup changes the Wiki instance directory hierarchy so that
1.11 +the top-level directory, instead of containing the conf and wikidata
1.12 +directories, contains the Wiki configuration file (unless located elsewhere -
1.13 +see the site_config setting) plus data, underlay and htdocs directories. See
1.14 +the migration section below for details.
1.15 +
1.16 Usage
1.17 -----
1.18
1.19 @@ -18,6 +27,51 @@
1.20 created. See the supplied moinsetup.cfg file for an example file which can
1.21 be modified and used for this purpose.
1.22
1.23 +An alternative configuration file is specified using the -f option:
1.24 +
1.25 + python moinsetup.py -f mywiki.cfg
1.26 +
1.27 +Configuration files provide information about the MoinMoin installation and a
1.28 +particular Wiki instance and Web site where the instance is published.
1.29 +
1.30 +Migration from moinsetup 0.2
1.31 +----------------------------
1.32 +
1.33 +The Wiki instance directory hierarchy has changed in moinsetup 0.3 as
1.34 +illustrated below:
1.35 +
1.36 +wiki (old)
1.37 + conf
1.38 + (wikiconfig.py)
1.39 + data
1.40 + underlay
1.41 + wikidata
1.42 + ... (htdocs)
1.43 +
1.44 +wiki (new)
1.45 + (wikiconfig.py)
1.46 + data
1.47 + underlay
1.48 + (htdocs)
1.49 +
1.50 +Since the contents of wikidata is generally superfluous, since the files are
1.51 +mostly shared resources, that directory is no longer created and such shared
1.52 +resources are no longer copied into it. The htdocs directory is copied since
1.53 +it can be convenient to maintain a separate collection of static files so that
1.54 +they can be updated with theme-related changes without modifying common system
1.55 +files.
1.56 +
1.57 +To migrate old Wiki instance layouts, run the following command:
1.58 +
1.59 + python moinsetup.py -m migrate_instance
1.60 +
1.61 +Add an optional argument after the method name to run the migration method in
1.62 +test mode:
1.63 +
1.64 + python moinsetup.py -m migrate_instance test
1.65 +
1.66 +This will just print the actions to be taken when migrating the instance.
1.67 +
1.68 Configuration
1.69 -------------
1.70
1.71 @@ -225,7 +279,8 @@
1.72 names; improved the error reporting when settings are missing or
1.73 inappropriate.
1.74 * Flattened the Wiki instance hierarchy, putting the configuration, data,
1.75 - underlay and htdocs in the same top-level directory.
1.76 + underlay and htdocs in the same top-level directory. (See the migration
1.77 + section in the documentation for information on updating the hierarchy.)
1.78 * Changed the location of MoinMoin 1.9 resources, installing them in the
1.79 prefix hierarchy and copying only static resources into Wiki instances.
1.80 * Changed the handling of static resources with MoinMoin 1.9 to serve them