Support #7674

Move developer & end user documentation to gitbook and store in git repository

Added by Tuukka Lehtonen about 1 month ago. Updated 12 days ago.

Status:In ProgressStart date:
Priority:4Due date:
Assignee:Tuukka Lehtonen% Done:

0%

Category:-Spent time:-
Target version:-
Release notes:
Tags: doc, migration, 1.33.0
Story points-
Velocity based estimate-
ReleaseSimantics 1.33.0Release relationshipAuto

Description

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
  • Markdown is simpler and easier to read than the current mediawiki-formatted source
  • No more Mediawiki maintenance and migration of mediawiki-installations during 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.

Associated revisions

Revision a9ec58f0
Added by Tuukka Lehtonen about 1 month ago

First test on Simantics documentation using gitbook

Only few parts transferred and somehow quickly reformatted for now.
Lots of work remaining.

refs #7674

Change-Id: I1cf8b6a3da5ec14064f79d0a0c765899be1d8872

History

#1 Updated by Tuukka Lehtonen 12 days ago

  • Tags changed from doc, migration to doc, migration, 1.33.0
  • Release changed from 57 to 58

#2 Updated by Tuukka Lehtonen 12 days ago

  • Due date deleted (2017-12-21)
  • Target version deleted (2017-28)
  • Start date deleted (2017-12-08)

Also available in: Atom PDF