From b58c30889e8fb25aa43bf26aa18168e4fe62919b Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Wed, 5 Sep 2018 11:17:47 +0100 Subject: [PATCH] Updated FAQ and contribution guide --- CONTRIBUTING.md | 7 +++++++ docs/faq/index.html | 11 +++++++++++ readme/faq.md | 12 ++++++++++++ 3 files changed, 30 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 418ce7767..6c4665318 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,3 +17,10 @@ Again, please check that it has not already been requested. If it has, simply ** If you want to add a new feature, consider asking about it before implementing it or checking existing discussions to make sure it is within the scope of the project. Of course you are free to create the pull request directly but it is not guaranteed it is going to be accepted. Building the apps is relatively easy - please [see the build instructions](https://github.com/laurent22/joplin/blob/master/BUILD.md) for more details. + +# Coding style + +There are only two rules, but not following them means the pull request will not be accepted (it can be accepted once the issues are fixed): + +- **Please use tabs, NOT spaces.** +- **Please do not add or remove optional characters, such as spaces or colons.** Please setup your editor so that it only changes what you are working on and is not making automated changes elsewhere. The reason for this is that small white space changes make diff hard to read and can cause needless conflicts. \ No newline at end of file diff --git a/docs/faq/index.html b/docs/faq/index.html index f01e6ccdc..823944fee 100644 --- a/docs/faq/index.html +++ b/docs/faq/index.html @@ -251,6 +251,17 @@

When I open a note in vim, the cursor is not visible

It seems to be due to the setting set term=ansi in .vimrc. Removing it should fix the issue. See https://github.com/laurent22/joplin/issues/147 for more information.

+

All my notes got deleted after changing the WebDAV URL!

+

When changing the WebDAV URL, make sure that the new location has the same exact content as the old location (i.e. copy all the Joplin data over to the new location). Otherwise, if there's nothing on the new location, Joplin is going to think that you have deleted all your data and will proceed to delete it locally too. So to change the WebDAV URL, please follow these steps:

+
    +
  1. Make a backup of your Joplin data in case something goes wrong. Export to a JEX archive for example.
    2. +
  2. Synchronise one last time all your data from a Joplin client (for example, from the desktop client)
    3. +
  3. Close the Joplin client.
    4. +
  4. On your WebDAV service, copy all the Joplin files from the old location to the new one.
    5. +
  5. Once it's done, open Joplin again and change the WebDAV URL.
    6. +
  6. Synchronise to verify that everything is working.
    7. +
  7. Do step 4 and 5 for all the other Joplin clients you need to sync.
    8. +

Is it possible to use real file and folder names in the sync target?

Unfortunately it is not possible. Joplin synchronises with file systems using an open format however it does not mean the sync files are meant to be user-editable. The format is designed to be performant and reliable, not user friendly (it cannot be both), and that cannot be changed. Joplin sync directory is basically just a database.

Could there be a PIN or password to restrict access to Joplin?

diff --git a/readme/faq.md b/readme/faq.md index 47b3da86c..7eee90051 100644 --- a/readme/faq.md +++ b/readme/faq.md @@ -2,6 +2,18 @@ It seems to be due to the setting `set term=ansi` in .vimrc. Removing it should fix the issue. See https://github.com/laurent22/joplin/issues/147 for more information. +# All my notes got deleted after changing the WebDAV URL! + +When changing the WebDAV URL, make sure that the new location has the same exact content as the old location (i.e. copy all the Joplin data over to the new location). Otherwise, if there's nothing on the new location, Joplin is going to think that you have deleted all your data and will proceed to delete it locally too. So to change the WebDAV URL, please follow these steps: + +0. Make a backup of your Joplin data in case something goes wrong. Export to a JEX archive for example. +1. Synchronise one last time all your data from a Joplin client (for example, from the desktop client) +2. Close the Joplin client. +3. On your WebDAV service, copy all the Joplin files from the old location to the new one. +4. Once it's done, open Joplin again and change the WebDAV URL. +5. Synchronise to verify that everything is working. +6. Do step 4 and 5 for all the other Joplin clients you need to sync. + # Is it possible to use real file and folder names in the sync target? Unfortunately it is not possible. Joplin synchronises with file systems using an open format however it does not mean the sync files are meant to be user-editable. The format is designed to be performant and reliable, not user friendly (it cannot be both), and that cannot be changed. Joplin sync directory is basically just a database.