Potential Documentation Platforms
The Fluid community is planning to move the Infusion documentation out of Confluence to a new platform. This page is a worksheet for summarizing evaluations of the various options being considered.
This table is a work in progress.
| Confluence | MediaWiki | MindTouch Deki | Drupal | WordPress | DocBook/ DITA | Markdown (or similar) | Sphinx |
|---|---|---|---|---|---|---|---|---|
Description | wiki | wiki | wiki | CMS | XSLT transformation of XML | XSLT transformation of XML, very structured | structured mark-up, very simple | reStructuredText & DocUtils, more structured |
Used by | Infusion | Handbook | php.net |
| Django, Python | |||
Must-Have Requirements | Confluence | MediaWiki | MindTouch Deki | Drupal | WordPress | DocBook/ DITA | Markdown (or similar) | Sphinx |
documentation must be accessible and transformable (output should be HTML styled using CSS) |
|
| |
|
|
|
|
|
anyone (on the core team or in the community) can contribute to the documentation |
|
|
|
|
| | | |
the authoring interface must be accessible |
|
| |
| | |
|
|
we can embed components/JS in the documentation to allow working examples |
|
|
| | | |
| |
there must be a means to have a "staging area" where docs can be written, updated etc. before becoming publicly available |
|
|
| | | | | |
Would-be-nice Requirements | Confluence | MediaWiki | MindTouch Deki | Drupal | WordPress | DocBook/ DITA | Markdown (or similar) | Sphinx |
the platform should be open source |
|
| |
| | | | |
documentation can be versioned to match numbered releases |
| |
|
|
|
|
|
|
anyone can comment on or discuss the documentation (e.g. comments on Confluence pages, "discuss" pages in wikipedia) |
|
|
|
|
|
|
| |
pages can be tagged |
|
|
|
| |
|
| |
documentation can be made available in PDF |
| | |
|
|
|
|
|