mantisbt:7075:vision
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
mantisbt:7075:vision [2006/05/17 08:08] – created vboctor | mantisbt:7075:vision [2020/05/14 08:34] (current) – Since 2008, this page is just a redirect stub; deleting it after setting up a proper redirection using Redirect plugin dregad | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Introduction ====== | ||
- | This pages outlines the approach to be taken in order for Mantis to support integration with a Wiki. | ||
- | |||
- | ====== Why? ====== | ||
- | |||
- | Mantis covers very well the area of bugtracker, however, when developers are implementing features that require some sort of upfront brain storming, documentation, | ||
- | |||
- | For agile environments the use of Wiki to manage such documentation is a good option. | ||
- | |||
- | ====== Integration ====== | ||
- | |||
- | ===== Single Sign-on ===== | ||
- | |||
- | Mantis users must not need to login into the Wiki. The wiki must automatically recognise the logged in Mantis user. | ||
- | |||
- | ===== Authorisation ===== | ||
- | |||
- | What a user can do must depend on their Mantis access level. | ||
- | |||
- | ===== Integration with Multiple Engines ===== | ||
- | |||
- | The integration must be implemented in a way where it is possible to integrate multiple wiki engines with Mantis. | ||
- | |||
- | ===== How will this affect Mantis? ===== | ||
- | |||
- | * The issue view pages must have a link that points to the Wiki page that corresponds to the current issue. | ||
- | |||
- | * It should be possible to add a Wiki column that has an icon that links directly to the Wiki page. This is similar to the pen icon that links directly to the update page. | ||
- | |||
- | * string_display_links() should also detect wiki links and hyper link them. | ||
- | |||
- | * Configuration items must be added to allow turning on/off Wiki integration, | ||
- | |||
- | * wiki_api.php, | ||
- | |||
- | * wiki_dokuwiki_api.php, | ||
- | |||
- | * Each project should be associated with a wiki page. This page acts as the root for project documentation. | ||
- | |||
- | ===== How will this affect the Wiki engine? ===== | ||
- | |||
- | The wiki engine will be changed as follows: | ||
- | * Use Mantis authentication. | ||
- | * Use Mantis authorisation (access control). | ||
- | * Support for adding a header and footer that integrates the Wiki into Mantis interface and potentially into the customer' | ||
- | * Ability to link to a Mantis issue (similar to #123 that is used within Mantis). | ||
- | * Support for Mantis specific fields, e.g. id, summary, reporter, developer, etc. Such fields will be replaced at rendering time with actual values supplied by Mantis. | ||
- | * Mantis Menu | ||
- | * The issue wiki page must have a link back to the view page of the issue. | ||
- | |||
- | ===== Wiki Storage ===== | ||
- | |||
- | Ideally the Wiki data should be stored in the same database as Mantis. | ||
- | |||
- | ===== Directory Structure ===== | ||
- | |||
- | * Mantis should provide the flexibility to link with a Wiki that is installed in any location on the same server or network. | ||
- | |||
- | * In the case where the Wiki is used only by Mantis, then it would be placed under the Mantis folder (e.g. mantis/ | ||
- | |||
- | * In the case where the Wiki will be used outside the scope of Mantis, then it would be placed in another location. | ||
- | |||
- | ===== Notifications ===== | ||
- | |||
- | Notifications related to Wiki page changes will be handled by the Wiki engine. | ||
- | |||
- | ===== Wiki Namespaces ===== | ||
- | |||
- | There are several approaches for how the Wiki is to be structured. | ||
- | |||
- | * Mantis: | ||
- | * Advantage: Nice structure, no need to use namespaces for internal links within the same project. | ||
- | * Advantage: It will be easier to backup all pages relating to a project, these may be imported somewhere else. For example, in the case of Docuwiki file storage, a namespace is a folder. | ||
- | * Disadvantage: | ||
- | |||
- | * Mantis - A single namespace that includes a page per issue and a page per project. | ||
- | |||
- | * Disadvantage: | ||
- | |||
- | ===== Templates ===== | ||
- | |||
- | There should be some support for Wiki page templates. | ||
- | |||
- | ===== Gotchas ===== | ||
- | |||
- | * Moving issues between projects. | ||
- | * Deleting an issue. | ||
- | * Cloning an issue. | ||
- | * Deleting a project. | ||
- | * Changing a project name. | ||
- | |||
- | ====== Distribution ====== | ||
- | |||
- | * Mantis will be distributed with the code necessary to integrate with the Wiki, but not with the code of the actual Wiki. | ||
- | |||
- | * Enough documentation will be able to indicate the supported Wikis and whatever work necessary to get the integration working. | ||
- | |||
- | * In the future, a default Wiki may be included as part of Mantis distribution. | ||
- | |||
- | ====== Proposed Wiki Engines ====== | ||
- | |||
- | * [[http:// | ||
- | |||
- | ====== Related Links ====== | ||
- | |||
- | * [[http:// | ||
- | * [[http:// |
mantisbt/7075/vision.1147867720.txt.gz · Last modified: 2008/10/29 04:36 (external edit)