History: Basic Docs Project

• «
• »

            This project was featured in an [http://doc.tiki.org/tiki-read_article.php?articleId=11|article] March 1, 2007.

^__Project Control:__ 
*Please list/link all pages to be modified below. 
*Edit the project outline as necessary. 
*Add questions and Answers to the ((Basic Docs Project FAQ))
^
!!Installation

[http://doc.tiki.org/Installation]

The objectives for ((Installation)) are as follows:

__1. Copy and Redirect pages from Tiki.org__

Tiki.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).

Install by SSH
((Install by FTP))
Install from panel 
Install from command line linux
Install Windows
Register your Tiki site

__2. Explaining the Tiki Architecture__

Tiki Folders Explained
an explanation of what you see in the main directory including

* what it does
* which folders need to be backed up (contain user specific files)
* secure permissions for each folder 
* optional folders (can be deleted if feature is not in use?) (but not until you backup your initial install, right?)

!! What to do first
((Initial Configuration))
* change admin password
* set up groups
* set up users
* configure homepage

!! Backup Instructions

The hub will be at ((Backup))
http://doc.tiki.org/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.
* how to restore the database
* how to restore the Tiki fileset
* An untested backup is a worthless backup

!! Upgrade

The hub page will be (surprise!) ((Upgrade)). 

[http://doc.tiki.org/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.x 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
paths including:
* instructions for upgrading Tiki files.
* instructions for upgrading the database.
* instructions for upgrading themes.