Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DvogelHallowelt committed Dec 5, 2024
1 parent 904f287 commit f5f849d
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,18 @@ This is a command line tool to convert the contents of a Dokuwiki into a MediaWi

## Workflow
### Prepare migration
1. Create a directory for the migration (e.g. `/tmp/migration/workspace/` ).
2. Create a directory for the migration (e.g. `/tmp/migration/workspace/input` ).
3. Copy the `data` directory from dokuwiki to `/tmp/migration/workspace/input`.
1. Create a directory for the migration source (e.g. `/tmp/migration/input/` ).
2. Create a workspace directory for the migration (e.g. `/tmp/migration/workspace/` ).
3. Copy the dokuwiki `data` directory from dokuwiki to `/tmp/migration/workspace/input`.
4. Remove unused directories before copying. Only `attic`,`media`, `media-attic`, `media-meta`, `meta`, `pages`, can be used for migration. `attic` and `media-attic` contain older versions and are not required for migration.
5. If attic versions should be migrated all archived versions have to be extracted (e.g. `find . -name "*.gz" -exec gunzip {} \;` on linux systems).

### Migrate the contents
1. Create the "workspace" directory (e.g. `/tmp/migration/workspace/` )
2. From the parent directory (e.g. `/tmp/migration/` ), run the migration commands
1. Run `migrate-dokuwiki analyze --src input/ --dest workspace/` to create "working files". After the script has run you can check those files and maybe apply changes if required (e.g. when applying structural changes).
2. Run `migrate-dokuwiki extract --src input/ --dest workspace/` to extract all contents, like wikipage contents, attachments and images into the workspace
3. Run `migrate-dokuwiki convert --src workspace/ --dest workspace/` (yes, `--src workspace/` ) to convert the wikipage contents from Confluence Storage XML to MediaWiki WikiText
4. Run `migrate-dokuwiki compose --src workspace/ --dest workspace/` (yes, `--src workspace/` ) to create importable data
From the parent directory (e.g. `/tmp/migration/` ), run the migration commands
1. Run `migrate-dokuwiki analyze --src input/ --dest workspace/` to create "working files". After the script has run you can check those files and maybe apply changes if required (e.g. when applying structural changes).
2. Run `migrate-dokuwiki extract --src input/ --dest workspace/` to extract all contents, like wikipage contents, attachments and images into the workspace
3. Run `migrate-dokuwiki convert --src workspace/ --dest workspace/` (yes, `--src workspace/` ) to convert the wikipage contents from Confluence Storage XML to MediaWiki WikiText
4. Run `migrate-dokuwiki compose --src workspace/ --dest workspace/` (yes, `--src workspace/` ) to create importable data

If you re-run the scripts you will need to clean up the "workspace" directory!

Expand Down

0 comments on commit f5f849d

Please sign in to comment.