Loading...
 

InstallTikiDev

Philosophy and resulting guidelines

[+]

Installing Tiki is a fun, fast and efficient guided process

  • At any point in time the user is told what to do next.
  • Wherever user input is required, options are explained. A default value is investigated and offered where it makes sense (e.g. for the webserver document root).
  • Errors are handled as verbose as possible. Wherever possible, hints on a solution or links to further help are given.
  • The setup process requires as few changes of media as possible (shell script, sql statements, ftp, web interface)
  • Wherever possible, setup and administration is handled through a web interface

Tiki is easy to install, even with very basic server administration skills and technical conditions

  • Tiki setup avoids requiring special skills where possible
  • Sometimes it is necessary to introduce concepts that might be new to a user (e.g. permission handling). In that case documentation is sufficient so a non-technical user can still follow.
  • Technical requirements are minimal (like ftp-access to a server and a shared database); there is sufficient documentation on how to deal with restricted environments
  • Tiki is as independent of the environment as possible, such that it feels the same regardless what hardware or operating system it runs on.

Tiki adapts to the needs of the admin

  • It is easy to create a Tiki instance that looks and feels like it was custom tailored for a specific user group (e.g. teaching, documentation, fanpage, team coordination) - see TikiProfilesDev and ContentPacks.
  • In particular, features or extensions that might cause difficulties can easily be disabled, which makes the difficulties magically vanish. (e.g. TikiMap and Graphviz installation)
  • Once the user has chosen a certain configuration, the disabled functionality is hidden.
    • For example, disabled features don't show in the admin menu ( GettingStartedToDo ).

Contributions to the setup process are easily done, well coordinated and in line with user interest

  • The setup process is well documented
  • Wherever possible, contributions are done according to the philosophy and guidelines above
  • Any improvement is checked whether it could be generalizable.
  • User problems and ideas are funneled to the developer space wherever that makes sense (e.g. by providing a link with an error message)
    • relevant RFEs and Bug reports find their way to the TikiTeamGettingStarted .
    • GettingStartedToDo: Provide a help page for setup errors that guides to the relevant parts of the documentation, Fori, and Bug Trackers. Frequently occuring problems should be handled in an interactive way (Forum, Wiki), so that users can help solving.

General Outline of the Setup Process (how it would be nice)

[+]

Status / Roadmap / To Do

[+]

Status

At the moment, we have a working setup process, that doesn't fulfill many of the guidelines above. Documentation is only a small README in the distribution and what we have here under InstallTiki... Way to go, yeehaaaa!

Roadmap

  • For Release 1.7: Working install help environment under InstallTikiHelp, dedicated to help on 1.7 problems
  • For Release 1.7.1: Improved webbased guided install
  • How fast we can implement the other items in the outline above will depend on how TikiTeamGettingStarted evolves...
  • I suppose there will also be other new cool aspects we will implement; Lorinc already brought great ideas. Watch InstallTikiDev !

Todo

See GettingStartedToDo .

Competition / Inspiration / Standards

[+]

Trackers

[+]
Created by: Last Modification: Monday 08 June 2009 16:44:57 GMT-0000 by Marc Laporte
List Slides