Document properly the paths where data and configuration are saved/loaded

kiwix / kiwix-desktop

Kiwix for Windows and GNU/Linux desktops

https://download.kiwix.org/release/kiwix-desktop/

GNU General Public License v3.0

737 stars 96 forks source link

Document properly the paths where data and configuration are saved/loaded #1114

Open kelson42 opened 2 months ago

kelson42 commented 2 months ago

We should have in the GitHub wiki a page which should have one entry per thing we save on the local filesystem with the following information:

file which is saved
Purpose
When it is written/updated
Default path on Linux
Default path on Windows
Customisable: yes/no

Here a few comments helpful:

kelson42 commented 1 month ago

@sgourdas That would be the next task to do.

kelson42 commented 1 month ago

@sgourdas Everything clear on this issue? Anything stopping you to move forward?

sgourdas commented 1 month ago

@kelson42 I will have a WIP published soon, for a second look.

sgourdas commented 1 month ago

@kelson42 I published a V1. I would appreciate some directions if possible, since I am not sure about my workflow.

kelson42 commented 1 month ago

@sgourdas where it is? link?

sgourdas commented 1 month ago

Here you are

kelson42 commented 1 month ago

@sgourdas Sorry for the late feedback. I would like to see things in a table format. I have created a stub of one at the top of the page. Please complete it and put real paths so this is to figure out where are things.

sgourdas commented 1 month ago

@kelson42 I moved the information in your table. For files like library.xml where the path is evaluated in a series of steps how would you like to present the information?

Specifically for this as per mgautierfr's comment is goes like:

Use library.xml in local directory if it exists
Use system/user library.xml if it exists
Move library.xml from old/wrong directory to new/good one.
Else, create a system library.xml and use it.

kelson42 commented 4 weeks ago

Here my remarks:

For library.xml and where it could be, this is - for now - an other topic
$APPDATA is not clear, please replace by something clearer which fit to the reality
Please create a dedicated column for flatpak
For the ZIM, why do we have two paths $HOME/.local/share/kiwix and $HOME/.local/share/kiwix, again here things should be more clear
ZIM path can be customisable in the app itself, why there is a cross?
What is the different between kiwix-desktop.session and kiwix-desktop.conf, it is really not clear why we have two files?
If you first version is not useful anymore, please remove it
What does mean "executable directory", why we have two path. Please put only the default path.

sgourdas commented 3 weeks ago

$APPDATA is not clear, please replace by something clearer which fit to the reality

I tried to make the paths shorter using $APPDATA for %appdata%. Maybe using %appdata% is better or do you prefer the full path?

ZIM path can be customisable in the app itself, why there is a cross?

With Customisable do we mean that the path can be changed? Or that its use-case can be customized? In the first case would it be clearer to call it Modifiable?

What is the different between kiwix-desktop.session and kiwix-desktop.conf, it is really not clear why we have two files?

kiwix-desktop.session is used for the app's automatic session information whereas kiwix-desktop.conf is used for user specific settings. I changed the wording to make it more clear.