The Tikiwiki Editorial Board members mlpvolt and dthacker are organizing a doc project to renew the basic documentation for Installing, Upgrading and Backing Up Tikiwiki. We are coordinating this with some of our lead developers, but everyone can contribute both questions and answers. We will also be closing and redirecting the identical pages on tikiwiki.org to prevent wasted effort and misinformation. If you have any questions on this doc project, add them to the Basic Docs Project FAQ
The objectives for Installation are as follows:
1. Copy and Redirect pages from Tikiwiki.org
Tikiwiki.org has many pages with install information. Most, if not all, are outdated. We should ensure the documentation supports both those who use SSH and FTP (and for those with no root access).
2. Explaining the Tikiwiki Architecture
Tikiwiki Folders Explained
an explanation of what you see in the main directory including
- what is does
- which folders need to be backed up (contain user specific files)
- required permissions for each folder
- optional folders (can be deleted if feature is not in use?)
The hub page will be (surprise!) Upgrade.
1. Documenting Upgrade Paths
The object is not to provide generic upgrade instructions but clear, (idiot proof) step by step tutorials for each normal upgrade path. e.g. Upgrade 1.9.4 to 1.9.7
Similar content can easily be copied back and forth. Let's give users the confidence to do it right.
Non-typical upgrade paths should not be documented and thus be discouraged.
Each page should contain specific instruction pages for normal upgrade
- instructions for upgrading tikiwiki files.
- instructions for upgrading the database.
- instructions for upgrading themes.
The hub will be at Backup
simple instructions on backing up the files DB, with specific pages for different hosting environments.
- advice when to backup
- about the ISP backup
- which tiki folders contain user data.
- how to set up automatic backups.