Reference
The reports and the record
A migration keeps a record of every decision anyone made on it: who, when, and what exactly. Two PDF reports turn that record, and everything the migration measured, into documents you can keep after the source instance is deleted: a summary for your client, and the technical report.
Summary for your client
One or two pages, written for the site owner, who has never heard of the tool's checks. It carries the Insites logo and no one else's, so you can send it as it is.
- The site's old address and its new one, and the date it was checked.
- The result in one line, for example 4,295 of 4,352 confirmed: 50 do not match and 7 could not be checked, and whether every check passed.
- What was copied, counted in the source's own words: pages, items, people, files.
- What stayed behind, and why, in plain words. Anything only an engineer could read is left to the technical report, which the summary points to.
- What is left to do: the cutover steps not done yet.
Technical report
The whole migration. It opens with the same result line as the summary.
- The source and the destination, the migration's id, who started it and when.
- The Verification log: every verification, and every check with what it measured. An appendix at the end says what each check was first tried on, to show it can fail.
- Everything the source held, by module, and where each part went.
- Every decision, in order: starting the run, each fix and its reason, what the load carried, the approval with the plan's code, rollbacks, cutover steps, finishing.
- What changed on the way, and what was left behind and why.
- The code that was copied, replaced or refused, and the files copied.
- The To do list: every job, how many are done, and for each one ticked done, when and by whom.
- Each push of the To do list to Teamwork, and each time the code was sent to GitHub, with the repository, the branch and the pull request, by whom and when. Send the code to GitHub.
Neither report contains a key, a password, a constant's value or a row of the site's data.
Where they are kept
Make either one on the Report step of the Launch stage. Each report is stored in the migration tool's own database, with a fingerprint of the file that changes if the file changes, and can be downloaded again from the same step for as long as the migration exists. Make a new one at any point: each is kept, newest first in the list, which says which report each one is.