platform issueshttps://gitlab.simantics.org/simantics/platform/-/issues2023-12-04T19:50:33Zhttps://gitlab.simantics.org/simantics/platform/-/issues/99Move developer & end user documentation to Markdown and store in git repository2023-12-04T19:50:33ZTuukka LehtonenMove developer & end user documentation to Markdown and store in git repositoryPros:
* Automatically version the documentation with the code and publish online in the same web-location as all the software components related to the release
* Also, every single version of the documentation will be readily available...Pros:
* Automatically version the documentation with the code and publish online in the same web-location as all the software components related to the release
* Also, every single version of the documentation will be readily available in the repository and publishable online
* More possibilities to transcode the documentation into other formats (gitbook, dita, docz, gatsbyjs, ...)
* Markdown is simpler and easier to read than the current mediawiki-formatted source
* No more updating, maintenance and migration of mediawiki-installations and fixing after OS upgrades
* ...
Cons:
* Editing the documentation isn't as easy as going into a wiki and changing it but this is nothing compared to the pros.
The pros outweight the cons by a mile.
Originally from [redmine 7674](https://www.simantics.org/redmine/issues/7674).
----
* [ ] Reformat all relevant documentation from the old wiki into [docs](docs/) in this repository in Markdown format
* [ ] While moving every single document, assess its up-to-dateness. Remove or rewrite deprecated instructions.
* [ ] Take the old wiki offline or make it read-only and available at some backup address
* [x] Switch to using DITA for conversions from Markdown to other formats, such as Eclipse help
* [ ] Generate public website into pages.simantics.org through gitlab's pages mechanism
The Markdown should be written so that it can be read as such via Gitlab as the authoritative source of documentation without any extra generation.
Transfer TODO list at [docs/Developer/TODO.md](/docs/Developer/TODO.md)1.59.0Tuukka LehtonenTuukka Lehtonen