1.1 --- a/README.txt Sun Aug 10 18:41:20 2014 +0200
1.2 +++ b/README.txt Sun Aug 10 18:44:07 2014 +0200
1.3 @@ -10,12 +10,15 @@
1.4 --------------------
1.5
1.6 The following activities are involved in a migration from Confluence to
1.7 -MoinMoin:
1.8 +MoinMoin. First, the activities that can be performed from any location:
1.9
1.10 * Export of Confluence content
1.11 * Conversion of Confluence content to MoinMoin content
1.12 * Confluence page identifier extraction and mapping to MoinMoin identifiers
1.13 * Acquisition of Confluence user profile details
1.14 +
1.15 +Then, the activities that are performed on the server:
1.16 +
1.17 * Installation of MoinMoin
1.18 * Initialisation of a MoinMoin wiki instance
1.19 * Import of MoinMoin content into the new wiki instance
1.20 @@ -116,6 +119,9 @@
1.21 Quick Start
1.22 -----------
1.23
1.24 +(!) The acquisition of Confluence wiki content and its conversion can be
1.25 +performed from any location, not necessarily on the server.
1.26 +
1.27 To obtain XML export archives from a Confluence wiki instance, the
1.28 exportspacexml.action resource is visited and the "Export" button selected.
1.29 For example, for the Mailman Wiki, the appropriate resource (with the COM
1.30 @@ -145,6 +151,8 @@
1.31 contents. Thus, the above command would produce a directory called COM and an
1.32 archive called COM.zip.
1.33
1.34 +(!) The following step is performed on the server.
1.35 +
1.36 To import the result (although you may wish to process other namespaces
1.37 first), use moinsetup as follows:
1.38
1.39 @@ -158,6 +166,9 @@
1.40 Where more than one namespace is to be imported, the page packages should be
1.41 merged so that the resulting history information is ordered correctly.
1.42
1.43 +(!) This process can be performed from any location and the result uploaded to
1.44 +the server for eventual import.
1.45 +
1.46 To merge packages, use a command of the following form:
1.47
1.48 python merge.py OUT COM.zip DEV.zip DOC.zip SEC.zip
1.49 @@ -176,6 +187,10 @@
1.50 provides "tiny URLs" which are an alphanumeric encoding of the numeric
1.51 identifiers.
1.52
1.53 +(!) This process can be performed with the converted content from any
1.54 +location, with the generated files uploaded to the server for eventual
1.55 +deployment.
1.56 +
1.57 To generate mappings for the Confluence content, use the mappings script as
1.58 follows:
1.59
1.60 @@ -183,7 +198,9 @@
1.61
1.62 Here, COM is a directory name containing converted Confluence content,
1.63 corresponding to a space name in the original Confluence wiki. More than one
1.64 -space name can be used to generate a complete mapping for a site.
1.65 +space name can be used to generate a complete mapping for a site. For example:
1.66 +
1.67 +tools/mappings.sh COM DEV DOC SEC
1.68
1.69 The following files are generated:
1.70
1.71 @@ -270,27 +287,45 @@
1.72 This output can be edited and then passed to a program which fetches other
1.73 profile details as follows:
1.74
1.75 -tools/users.sh COM DEV DOC SEC > users.txt # for editing
1.76 -cat users.txt | tools/get_profiles.py http://wiki.list.org/
1.77 +tools/users.sh COM DEV DOC SEC > users.txt
1.78 +
1.79 +After editing...
1.80 +
1.81 + cat users.txt \
1.82 +| tools/get_profiles.py http://wiki.list.org/ \
1.83 +> profiles.txt
1.84
1.85 If no users are to be removed in migration, the following command could be
1.86 issued:
1.87
1.88 -tools/users.sh COM DEV DOC SEC | tools/get_profiles.py http://wiki.list.org/
1.89 + tools/users.sh COM DEV DOC SEC \
1.90 +| tools/get_profiles.py http://wiki.list.org/ \
1.91 +> profiles.txt
1.92
1.93 The get_profiles.py program needs to be told the URL of the original
1.94 Confluence site. Note that it accesses the site at a default rate of around
1.95 one request per second; a different delay between requests can be specified
1.96 using an additional argument.
1.97
1.98 +(!) The above steps can be performed from any location, but the command
1.99 +pipelines below need to be run on the server due to the use of a program that
1.100 +updates the deployed wiki.
1.101 +
1.102 The output of the get_profiles.py program can be passed to another program
1.103 which adds users to MoinMoin, and so the following commands can be used:
1.104
1.105 + cat profiles.txt \
1.106 +| tools/addusers.py wiki
1.107 +
1.108 +Alternatively, the users can be converted to profiles and immediately added
1.109 +without creating a profiles file:
1.110 +
1.111 cat users.txt \
1.112 | tools/get_profiles.py http://wiki.list.org/ \
1.113 | tools/addusers.py wiki
1.114
1.115 -And using one single command:
1.116 +Or just using one single command without inspecting the users or profiles at
1.117 +all:
1.118
1.119 tools/users.sh COM DEV DOC SEC \
1.120 | tools/get_profiles.py http://wiki.list.org/ \