Feat: add documentation about how to upgrade development.ini on existing installation to upgrade tracim

PhilippeAccorsi commented 4 years ago

Feature description

Have a small documentation about using meld software to update development.ini file on existing installation.

First => download new development.ini.sample
second => use meld to update your file

Context

At present its not really explicit how to upgrade tracim and what do you need to do that. By default, its not necessary to chnage something, just download new version and start installation script (on local) or start docker.

We can add a small documentation about how update development.ini file, and when some change is make in this file (with new release), we can add message in changelog about "you need to use this documentation to upgrade config file for this Tracim version".

For docker we add link to download development.ini.sample first, and user can update his hown file before starting docker tracim again (with new version).

With this, we can make sure, development.ini config not break Tracim. Its not easy to create an automatic script to do that because many parameter can be changed manualy by user.

Prerequisites

Impacted components

documentation

Extra information

We need basic documentation about how to upgrade tracim also if we not chnage anything in development.ini :

stop tracim
git pull
start all tree install default script to update your file
start tracim

Related to #1810

PhilippeAccorsi commented 4 years ago

After some discuss:

explain how to upgrade tracim
explain how to update config file (whis prefered software to make diff)
add name of 1-3 software to make diff (meld, etc.).

PhilippeAccorsi commented 3 years ago

Its also important for docker installation where normal user not have development.ini.sample to compare with his existing file.

PhilippeAccorsi commented 1 year ago

@Relf-Algoo I think it is a good idea to put this kind of documentation in community plateform. Can you done that ? This idea here is to have the documentation (in french) to understand how I can update my local development.ini file when new version of tracim is available.

Relf-Algoo commented 1 year ago

@PhilippeAccorsi is there a file somewhere, a doc that I can translate in french ?

PhilippeAccorsi commented 1 year ago

For the moment I don't think documentation exist (or not exploitable directly). I think we need to create from scratch.

tracim / tracim