From abcb1ac7603e79d9bb2e32d3b48e9456e3d5e5db Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Wed, 25 Apr 2018 19:24:13 +0200 Subject: [PATCH] Doc: Update website --- README.md | 1 + Tools/build-website.js | 3 +- docs/changelog/index.html | 3 +- docs/debugging/index.html | 3 +- docs/desktop/index.html | 3 +- docs/donate/index.html | 3 +- docs/e2ee/index.html | 3 +- docs/faq/index.html | 298 ++++++++++++++++++++++++++++++++++++++ docs/index.html | 17 ++- docs/mobile/index.html | 3 +- docs/spec/index.html | 3 +- docs/stats/index.html | 3 +- docs/terminal/index.html | 3 +- 13 files changed, 328 insertions(+), 18 deletions(-) create mode 100644 docs/faq/index.html diff --git a/README.md b/README.md index 0de66a760..1ce13da2c 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,7 @@ For usage information, please refer to the full [Joplin Terminal Application Doc - [How to enable end-to-end encryption](https://github.com/laurent22/joplin/blob/master/readme/e2ee.md) - [End-to-end encryption spec](https://github.com/laurent22/joplin/blob/master/readme/spec.md) - [How to enable debug mode](https://github.com/laurent22/joplin/blob/master/readme/debugging.md) + - [FAQ](https://github.com/laurent22/joplin/blob/master/readme/faq.md) - About diff --git a/Tools/build-website.js b/Tools/build-website.js index e05942cc6..79c29a219 100644 --- a/Tools/build-website.js +++ b/Tools/build-website.js @@ -216,7 +216,7 @@ const headerHtml = `
@@ -387,6 +387,7 @@ async function main() { renderFileToHtml(rootDir + '/readme/terminal.md', rootDir + '/docs/terminal/index.html', {}); renderFileToHtml(rootDir + '/readme/debugging.md', rootDir + '/docs/debugging/index.html', {}); renderFileToHtml(rootDir + '/readme/desktop.md', rootDir + '/docs/desktop/index.html', {}); + renderFileToHtml(rootDir + '/readme/faq.md', rootDir + '/docs/faq/index.html', {}); renderFileToHtml(rootDir + '/readme/mobile.md', rootDir + '/docs/mobile/index.html', {}); renderFileToHtml(rootDir + '/readme/e2ee.md', rootDir + '/docs/e2ee/index.html', {}); renderFileToHtml(rootDir + '/readme/spec.md', rootDir + '/docs/spec/index.html', {}); diff --git a/docs/changelog/index.html b/docs/changelog/index.html index 37ad6d990..c9e467101 100644 --- a/docs/changelog/index.html +++ b/docs/changelog/index.html @@ -211,7 +211,7 @@
@@ -237,6 +237,7 @@
  • How to enable end-to-end encryption
  • End-to-end encryption spec
  • How to enable debug mode
    • +
  • FAQ
  • diff --git a/docs/debugging/index.html b/docs/debugging/index.html index 97d3c050e..f40a740ec 100644 --- a/docs/debugging/index.html +++ b/docs/debugging/index.html @@ -211,7 +211,7 @@
    @@ -237,6 +237,7 @@
  • How to enable end-to-end encryption
  • End-to-end encryption spec
  • How to enable debug mode
    • +
  • FAQ
  • diff --git a/docs/desktop/index.html b/docs/desktop/index.html index 4ff1f25f8..4bd3330ac 100644 --- a/docs/desktop/index.html +++ b/docs/desktop/index.html @@ -211,7 +211,7 @@
    @@ -237,6 +237,7 @@
  • How to enable end-to-end encryption
  • End-to-end encryption spec
  • How to enable debug mode
    • +
  • FAQ
  • diff --git a/docs/donate/index.html b/docs/donate/index.html index a78185533..c93977942 100644 --- a/docs/donate/index.html +++ b/docs/donate/index.html @@ -211,7 +211,7 @@
    @@ -237,6 +237,7 @@
  • How to enable end-to-end encryption
  • End-to-end encryption spec
  • How to enable debug mode
    • +
  • FAQ
  • diff --git a/docs/e2ee/index.html b/docs/e2ee/index.html index 9996d5e65..bd2938b1c 100644 --- a/docs/e2ee/index.html +++ b/docs/e2ee/index.html @@ -211,7 +211,7 @@
    @@ -237,6 +237,7 @@
  • How to enable end-to-end encryption
  • End-to-end encryption spec
  • How to enable debug mode
    • +
  • FAQ
  • diff --git a/docs/faq/index.html b/docs/faq/index.html new file mode 100644 index 000000000..e66d3c6f2 --- /dev/null +++ b/docs/faq/index.html @@ -0,0 +1,298 @@ + + + + Joplin - an open source note taking and to-do application with synchronisation capabilities + + + + + + + + + + + + +
    + +
    + +

    oplin

     +

    An open source note taking and to-do application with synchronisation capabilities.

    +
    + +
    +
    + +
    + + + +
    +
    +
    + +
    + +

    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.

    +

    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?

    +

    Short answer: no. The end to end encryption that Joplin implements is to protect the data during transmission and on the cloud service so that only you can access it.

    +

    On the local device it is assumed that the data is safe due to the OS built-in security features. If additional security is needed it's always possible to put the notes on an encrypted Truecrypt drive for instance.

    +

    If someone that you don't trust has access to the computer, they can put a keylogger anyway so any local encryption or PIN access would not be useful.

    +

    Why is it named Joplin?

    +

    The name comes from the composer and pianist Scott Joplin, which I often listen to. His name is also easy to remember and type so it fell like a good choice. And, to quote a user on Hacker News, "though Scott Joplin's ragtime musical style has a lot in common with some very informal music, his own approach was more educated, sophisticated, and precise. Every note was in its place for a reason, and he was known to prefer his pieces to be performed exactly as written. So you could say that compared to the people who came before him, his notes were more organized".

    + + + +
    +Copyright (c) 2016-2018 Laurent Cozic +
    + + diff --git a/docs/index.html b/docs/index.html index 48b22d128..9482a4147 100644 --- a/docs/index.html +++ b/docs/index.html @@ -211,7 +211,7 @@
    @@ -237,6 +237,7 @@
  • How to enable end-to-end encryption
  • End-to-end encryption spec
  • How to enable debug mode
    • +
  • FAQ
  • @@ -489,14 +490,14 @@ $$ Croatian hr_HR -Hrvoje Mandić trbuhom@net.hr +Hrvoje Mandić trbuhom@net.hr 62% Czech cs_CZ -Lukas Helebrandt lukas@aiya.cz +Lukas Helebrandt lukas@aiya.cz 97% @@ -510,7 +511,7 @@ $$ Deutsch de_DE -Tobias Grasse mail@tobias-grasse.net +Tobias Grasse mail@tobias-grasse.net 96% @@ -524,7 +525,7 @@ $$ Español es_ES -Fernando Martín f@mrtn.es +Fernando Martín f@mrtn.es 100% @@ -538,7 +539,7 @@ $$ Galician gl_ES -Marcos Lans marcoslansgarza@gmail.com +Marcos Lans marcoslansgarza@gmail.com 97% @@ -559,14 +560,14 @@ $$ Português (Brasil) pt_BR -Renato Nunes Bastos rnbastos@gmail.com +Renato Nunes Bastos rnbastos@gmail.com 95% Русский ru_RU -Artyom Karlov artyom.karlov@gmail.com +Artyom Karlov artyom.karlov@gmail.com 96% diff --git a/docs/mobile/index.html b/docs/mobile/index.html index d8c0124fa..7478e1966 100644 --- a/docs/mobile/index.html +++ b/docs/mobile/index.html @@ -211,7 +211,7 @@
    @@ -237,6 +237,7 @@
  • How to enable end-to-end encryption
  • End-to-end encryption spec
  • How to enable debug mode
    • +
  • FAQ
  • diff --git a/docs/spec/index.html b/docs/spec/index.html index d0d31b4c7..973fb2d96 100644 --- a/docs/spec/index.html +++ b/docs/spec/index.html @@ -211,7 +211,7 @@
    @@ -237,6 +237,7 @@
  • How to enable end-to-end encryption
  • End-to-end encryption spec
  • How to enable debug mode
    • +
  • FAQ
  • diff --git a/docs/stats/index.html b/docs/stats/index.html index 110389585..9b74ce373 100644 --- a/docs/stats/index.html +++ b/docs/stats/index.html @@ -211,7 +211,7 @@
    @@ -237,6 +237,7 @@
  • How to enable end-to-end encryption
  • End-to-end encryption spec
  • How to enable debug mode
    • +
  • FAQ
  • diff --git a/docs/terminal/index.html b/docs/terminal/index.html index c0067da8e..1f430bb0c 100644 --- a/docs/terminal/index.html +++ b/docs/terminal/index.html @@ -211,7 +211,7 @@
    @@ -237,6 +237,7 @@
  • How to enable end-to-end encryption
  • End-to-end encryption spec
  • How to enable debug mode
    • +
  • FAQ