diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..ce34cf0a --- /dev/null +++ b/docs/README.md @@ -0,0 +1,7 @@ +# `wikiteam3` Documentation +Welcome to the (WIP) documentation of `wikiteam3`! + +References: + - [WikiTeam wiki](https://github.com/WikiTeam/wikiteam/wiki) + - [WikiTeam](https://wiki.archiveteam.org/index.php/WikiTeam) at the ArchiveTeam Wiki + - [WikiTeam3 tutorial](https://meta.miraheze.org/wiki/Backups#WikiTeam3) at Miraheze Meta diff --git a/docs/dump_structure.md b/docs/dump_structure.md new file mode 100644 index 00000000..b3201233 --- /dev/null +++ b/docs/dump_structure.md @@ -0,0 +1,65 @@ +# Dump Structure + +Local directory structure: + +``` +--wikidump +├── config.json +├── index.html +├── SpecialVersion.html +├── siteinfo.json +├── all_dumped.mark +├── uploaded_to_IA.mark +├── errors.log +├── --titles.txt +├── --history.xml +├── --images.txt +├── images +│ └── ... +├── images_mismatch +│ └── ... +└── --redirects.jsonl +``` + +Internet Archive item structure: + +``` +wiki-- +├── --dumpMeta +│ ├── config.json +│ ├── index.html +│ ├── SpecialVersion.html +│ ├── siteinfo.json +│ ├── errors.log +│ ├── --titles.txt.zst +│ ├── --images.txt.zst +│ └── --redirects.jsonl.zst +├── --history.xml.zst +├── --images.7z +├── --images_mismatch.7z +└── _logo. +``` + +## General + - `config.json`: Dump configuration. Used when [resuming an incomplete dump](https://github.com/saveweb/wikiteam3/blob/v4-main/README.md#resuming-an-incomplete-dump). + - `index.html`: Archive of `index.php` (the main page). + - `SpecialVersion.html`: Archive of `[[Special:Version]]`. + - `siteinfo.json`: Archive of Siteinfo API response. + - `all_dumped.mark`: Marks the end of the dump. Content: `