Project

General

Profile

MediawikiMigration » History » Version 5

Denis 'GNUtoo' Carikli, 05/01/2020 10:41 PM

1 1 Denis 'GNUtoo' Carikli
h1. MediawikiMigration
2
3 2 Kurtis Hanna
Redmine's wiki uses Textile markup, while MediaWiki uses the Markdown markup language. It looks some redmine has recently been working to make it easier to transition from textile to markdown: https://www.redmine.org/issues/32424 https://www.redmine.org/plugins/redmine_reformat
4
5 1 Denis 'GNUtoo' Carikli
TODO:
6
* Find links to projects that can help migrate the wiki content and compare them:
7
** Look if it's possible to keep the history to make sure that smaller contributors don't get forgetten
8
** Contact the Archive team to backup the redmins wiki
9
** Make sure it gets archived completely on archive.org/web
10
** Make sure it gets archived in files that can be restored (but without non public information like password hashes, etc)
11 3 Denis 'GNUtoo' Carikli
12
h2. Rationale
13
14 4 Denis 'GNUtoo' Carikli
The documentation on the Redmine wiki has lot of duplication of information. 
15
16
The solution that has been choosen for that is the following:
17
* Migrate part of the information in Wikidata.
18
* Use template and/or generate information from Wikidata.
19
20
Other solutions were also possible such as migrating to documentation system like pandoc, but doing that would increase a lot the required skills of potential contributors. 
21
22
Using complicated documentation systems has several issues:
23
* Practically speaking, it makes it impossible for many people that don't know how to program, to participate in Replicant, fix issues etc. This would be very problematic for diversity and inclusiveness of people as it would unnecessarily discriminate against people without such skills. We could also potentially loose important contributions.
24
* While it would make the job of contributors way easier than without any templating or ways to programmatically generate documentation, it also increase the dependency on people who knows how to use that documentation system.
25
26
Instead it would be better to use a documentation system that enable people without programming skills to easily contribute, while at the same time enabling people with programming skills to take advantage of it as well.
27
28 5 Denis 'GNUtoo' Carikli
Enabling to interface the documentation system with Wikidata also has many advantages:
29
* It enables to reuse the information across different projects with similar goals (libreplanet wiki, Parabola wiki), different goals (for instance we could share the work of documenting hardware with the wikipedia and wikidata community), or through custom made tools.
30
* It can isolate the tasks requiring some programming to the strict minimum: Using programming in documentation systems can makes it easy to generate huge quantity of information, and Wikidata makes it possible to contribute to the information itself without knowing how to program. The programming is then potentially only required to fetch and show / format the information that comes from Wikidata.
31
32 4 Denis 'GNUtoo' Carikli
Pros of mediawiki:
33 3 Denis 'GNUtoo' Carikli
* Can be interfaced with Wikidata.
34
* The syntax is easy enough to use by people that don't know how to program, many people are used to it, and at the same time it's well documented.
35
* The table syntax of redmine textile format is too complicated for several key contributors like dllud.
36
* The main functionality, including the preview work completely without JavaScript. GNUtoo had huge issues with the redmine preview not working without javascript, leading to many bad editions that are fixed in subsequent editions that are fixed in subsequent editions...
37
* Other projects like Libreplanet, and Parabola uses mediawiki
38
* Can be used offline thanks to projects like Kiwix
39 1 Denis 'GNUtoo' Carikli
* Can easily be backuped by external projects like thearchiveteam
40
41 4 Denis 'GNUtoo' Carikli
Cons of mediawiki:
42 1 Denis 'GNUtoo' Carikli
* We need to migrate, if possible in a way that preserves history
43 4 Denis 'GNUtoo' Carikli
* We loose the integration with redmine #<bug number> will have to
44
45
h2. Decision
46
47
At several conferences, including the Replicant conference in Paris in Summer 2019, and the FOSDEM, people were in favor of migrating to Mediawiki and didn't have objections to it.