Wiki Structure
From Habari Project
The Habari wiki has a hierarchical structure and is organized so that documentation intended for using Habari is most accessible, while development documentation is deeper in the hierarchy. This separation of content does not suggest a division between users and developers but intends to make the most introductory documents the most accessible. The wiki is also further organized using templates and categories. This page describes that structure.
Contents |
Main Wiki Structure
The main structure of the wiki includes pages targeted at people using Habari, pages about extending Habari, and pages about Habari's internals. When adding pages to the wiki, contributors should try to include pages at each level where appropriate, and these pages should be interlinked.
User and Community Pages
Most of the top level of the wiki's hierarchy, those pages that exist directly underneath http://wiki.habariproject.org, focus on the end user. For example, pages on installing Habari, using themes and plugins, or using the administrative interface are appropriate here.
Alongside the pages about using Habari are pages for Habari's community. These include information about how to get involved with the project and upcoming events, such as bug hunts. The Habari community is perhaps the most important aspect of the project. These pages are at the top level because the community is everybody.
These pages should use the community category.
Development Pages
Pages about extending Habari, such as those describing the creation of themes and plugins, should be placed in the dev sub-directory, http://wiki.habariproject.org/dev.
These pages should use the developer category.
Core Development Pages
Pages about Habari's internals should be placed in the core directory under the dev directory, http://wiki.habariproject.org/dev/core. Further sub-directories should be used as appropriate. For example, the pages describing Habari's internal classes are located in the classes sub-directory, http://wiki.habariproject.org/dev/core/classes.
These pages should use the core category.
Secondary Wiki Structure
Aside from pages that describe how to use or extend Habari, the wiki also contains information about aspects of the project itself.
Policy Pages
Pages about the management of the Habari project, such as this page, should be created under http://wiki.habariproject.org/policy.
These pages should use the policy category.
Release Pages
Pages about releases of the Habari software should be created under http://wiki.habariproject.org/releases.
These pages should use the releases category.
Links
Pages should interlink between sections as much as possible, especially in the main wiki. As an example, the plugins page tells users about what plugins are and how to install them, and links to the plugins page under dev, dev/plugins. This page describes how to create plugins, linking to other dev pages such as dev/hooks. Finally, the developer pages link to dev/core/plugins, which describes the internals of how plugins work, and links to pages like dev/core/classes/pluggable.
Take care not to create orphan pages, pages to which no other pages link.
