search

FreeCAD / FreeCAD-Homepage

The homepage at http://www.freecad.org
GNU Lesser General Public License v2.1
29 stars 44 forks source link

Improving the current documentation provider #190

Open Reqrefusion opened 2 months ago

Reqrefusion commented 2 months ago

FreeCad uses mediawiki for documentation. This is a very correct decision in order for MediaWiki to be miles ahead of its competitors in every respect. It is absolutely not logical to change this. However, the current wikimedia we use is very untouched in terms of features. You can see the version information and the plugins used here.

In this direction, I would like to recommend some plugins or whatever their names are that are also accepted by wikimedia.

CirrusSearch: It is a plugin that makes all searches used in wikimedia more accurate. Elastica also needs to be installed.

AdvancedSearch: It provides advanced search capability in addition to CirrusSearch.

MobileFrontend: It is the mobile solution that Wikipedia also uses. It is required for the MinervaNeue skin that Wikipedia uses. Timeless can also be used instead of this solution for mobile. These two skins should come installed, but I could not see it.

VisualEditor: Unfortunately, everyone's favorite wiki editor is not installed. It allows making changes in rich text format. In addition, CodeMirror and CodeEditor, which improve the experience, are also very useful.

The current membership system requires manual approval. Wikimedia has many plugins to overcome this: Abuse Filter, AntiSpoof, ConfirmEdit, FancyCaptcha, SpamBlacklist, TitleBlacklist, TorBlock CheckUser is also quite functional to prevent vandalism. In addition to these, the CentralAuth plugin, which allows the use of Merge account, is quite functional.

Collection: Allows editing as a printed book for the relevant wiki.

ElectronPdfService: Similarly, allows you to get the PDF version of the page.

Plugins that make it easier to communicate within the wiki:Echo, TranslationNotifications, Discussion tools, Flow, Newsletter, Universal­Language­Selector

Plugins to make the work of administrators easier:Nuke, CentralNotice, IP Info, LoginNotify, OATHAuth,

These are the ones that come to mind for now, I do not recommend plugins related to APIs etc. that may be extra for now. @kkremitzki

yorikvanhavre commented 2 months ago

We would actually in the future move away from mediawiki. This is outlined in https://github.com/FreeCAD/FreeCAD/issues/8558 . There has been a first attempt at https://github.com/gauriimaheshwarii/gsoc-2023 but still lacks follow-up

Reqrefusion commented 2 months ago

We would actually in the future move away from mediawiki. This is outlined in FreeCAD/FreeCAD#8558 . There has been a first attempt at https://github.com/gauriimaheshwarii/gsoc-2023 but still lacks follow-up

Such a transition is nothing but a waste of time. The problems mentioned are very easy to solve in the current situation. MediaWiki is a very effective tool, it just needs some love. The proposed solution is not reliable enough. The current wiki has not received any love, none of the necessary extensions have been installed. The best solution is to show love to the current wiki. I think it would be better to abandon this project if there is no follow-up.

It does not make sense to leave behind a system that is being worked on by millions of people and whose limits are being tested every day and move to something done by Facebook.

Also, it is much faster and easier to develop the current system than to move to a new system