mirror of
https://github.com/wekan/wekan.git
synced 2026-11-07 02:52:33 -05:00
Lauri Ojansivu
fea3c432e8
It was a flat list where the database was a filename prefix, in three spellings - MongoDB-Driver-System.md, mongodb-avx-qemu.md, MongoDB_OpLog_Enablement.md - plus FerretDB2-PostgreSQL.md and a ToroDB-PostgreSQL directory. Somebody asking "how do I run WeKan on PostgreSQL" had to read the prefixes to find out which files were even about their database. Now: Migrations, MongoDB, FerretDB (with 1 and 2, because v1 and v2 are different products with different backends) and ToroDB (with PostgreSQL). Each file keeps its name minus the redundant prefix - MongoDB/Driver-System.md, MongoDB/avx-qemu.md - and the old PostgreSQL.md, which was an index of FerretDB and ToroDB rather than a document about PostgreSQL, becomes the directory's README.md. Every directory has a README.md saying what is in it and where to go next, including FerretDB/1, which had no documentation at all until now although it is WeKan's default database and just gained four more backends. Links to a directory point at the DIRECTORY, not at its README.md, because README.md is what is opened by default. Every link that pointed into the old paths is updated - in docs, in docker-compose-ferretdb-v2-postgresql.yml, and in the wekan.fi website - and the relative links inside the moved files, which gained a directory level and so needed one more "../". tests/docsDatabases.test.cjs pins the layout, the READMEs, the directory links, that every relative link resolves, and that nothing outside CHANGELOG.md still names an old path. Thanks to xet7 !
Migrations
WeKan's own schema migrations: the ones that move existing boards, lists, cards and users to the shape a newer WeKan expects. This is not about migrating between databases — for that see ../MongoDB and ../FerretDB.
Everything in this directory is a historical record. It documents the old cron-driven migration system and the per-swimlane-lists migration, both of which have since been REMOVED; each file says so at its top. They are kept because they explain why the current system looks the way it does.
| File | What is in it |
|---|---|
| MIGRATION_SYSTEM_IMPROVEMENTS.md | What the old system did badly and what was changed |
| CODE_CHANGES_SUMMARY.md | The code those improvements touched |
| MIGRATION_SYSTEM_REVIEW_COMPLETE.md | The review that went with them |
| SESSION_SUMMARY.md | The summary of that review session |
| verify-migrations.sh | The script that verified the old system |
The migration system WeKan runs today is described in ../../Features/Admin-Panel/Problems/Migrations.md.