Skip to content

Commit aa1186c

Browse files
committed
Improving internal documentation, translating it in fr-FR.
1 parent 9af32ac commit aa1186c

2 files changed

Lines changed: 56 additions & 11 deletions

File tree

doc-sources/help-en-US.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,40 @@
11
## What is the purpose of Lambda Badger ?
22

3-
Lambda Badger is an webapplication that easily allows you to use notes, offline (or not) and on every platform *(smartphone, touchpads, computer, ...)*.
3+
Lambda Badger is an webapplication that easily allows you to manage your notes, offline (or not) and on multiple platforms *(smartphone, touchpads, computer, ...)*.
44

55
All you need is a *modern* browser that allows to use the last technologies that can run this webapplication :
66
- Javascript
77
- IndexedDB (or WebSQL)
88

9-
## Where are the data ?
10-
11-
By default, the data(base) is **only stored on your computer**.
12-
13-
Precisely, inside your web browser thanks to [IndexedDB](https://en.wikipedia.org/wiki/Indexed_Database_API) technology (via [PouchDB](https://pouchdb.com/)).
14-
159
<p class="v-alert v-alert--outline info--text">
1610
<i aria-hidden="true" class="v-icon material-icons theme--dark v-alert__icon">info</i>
1711
<span>If you are not accepting cookies, this application cannot save the data on your browser, so it can not works.</span>
1812
</p>
1913

14+
## Where are the data ?
15+
16+
By default, the data(base) is **only stored on your device**
17+
(precisely, inside your web browser thanks to [IndexedDB](https://en.wikipedia.org/wiki/Indexed_Database_API) technology).
18+
2019
<p class="v-alert v-alert--outline warning--text">
2120
<i aria-hidden="true" class="v-icon material-icons theme--dark v-alert__icon">priority_high</i>
22-
<span>If you are cleaning you browser (like cookies) there are significant risks that your local database will be erased !</span>
21+
<span>If you are cleaning you browser (like cookies), there are significant risks that your local database will be erased !</span>
2322
</p>
2423

25-
Fortunatly, Lambda Badger has several ways to save your data.
24+
Fortunatly, Lambda Badger allow you to save your data through several ways.
2625

2726
## Saving/Exporting your data
2827

29-
All this data can be replicated (in real time) on an free and open-source [CouchDB server](http://couchdb.apache.org/), which can be installed on your network (over internet or not).
28+
The whole database can be replicated (in real time) on an [CouchDB server](http://couchdb.apache.org/) (free and open-source).
29+
30+
This server can be installed on your network (over internet or not), or on your computer if you want to keep it simple.
31+
32+
There is also database as a service in the cloud like [IBM Cloudant](https://www.ibm.com/cloud/cloudant), if you are ready to store your data on a system that you do not control it.
33+
34+
This functionnality also allows you to use your data on multiple devices (like your smartphone **and** your desktop).
3035

3136
## Security
3237

3338
If you are exposing your database through internet, you must have to set security settings on the CouchDB interface.
3439

35-
If you are launching another application locale which uses the same URL (http://localhost/) so it can access on your data. (*we will study an option to encrypt the data in a future release*).
40+
If you are launching another locally webapplication which uses the same URL (http://localhost/) so it can access on your data of Lambda Badger (*we will study an option to encrypt the data in a future release*).

doc-sources/help-fr-FR.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## Qu'est-ce que Lambda Badger ?
2+
3+
Lambda Badger est une application web qui vous permet facilement de gérer vos notes, hors réseau (ou non) et multi-platformes *(intelliphone, tablettes, ordinateurs, ...)*.
4+
5+
Tout ce que vous avez besoin d'un navigateur *moderne* qui vous permet d'utiliser les dernières technologies qui servent à faire fonctionner cette application web :
6+
- Javascript
7+
- IndexedDB (ou WebSQL)
8+
9+
<p class="v-alert v-alert--outline info--text">
10+
<i aria-hidden="true" class="v-icon material-icons theme--dark v-alert__icon">info</i>
11+
<span>Si vous refusez les cookies, cette application ne pourra pas enregistrer les données dans votre navigateur, donc elle ne fonctionnera pas.</span>
12+
</p>
13+
14+
## Où sont les données ?
15+
16+
Par défaut, la base de données est **stockée unique sur votre périphérique**
17+
(plus précisément, dans votre navigateur web grâce à la technologie [IndexedDB](https://fr.wikipedia.org/wiki/Indexed_Database_API)).
18+
19+
<p class="v-alert v-alert--outline warning--text">
20+
<i aria-hidden="true" class="v-icon material-icons theme--dark v-alert__icon">priority_high</i>
21+
<span>Si vous nettoyez votre navigateur (comme les cookies), il y a de gros riques que votre base de données locale soit effacée !</span>
22+
</p>
23+
24+
Heureusement, Lambda Badger vous permet de sauvegarder vos données de plusieures façons.
25+
26+
## Sauvegarder/Exporter vos données
27+
28+
Toute la base de donnée peut être répliquée (en temps réel) sur un [serveur CouchDB](http://couchdb.apache.org/) (libre et open-source).
29+
30+
Ce serveur peut être installé dans votre réseau (à travers internet ou non) - ou sur votre ordinateur si vous voulez faire simple.
31+
32+
Il existe aussi des services de base de données dans *l'infonuagique* (cloud) comme par exemple [IBM Cloudant](https://www.ibm.com/cloud/cloudant), si vous être prêt à héberger vos données sur un système dont vous n'avez pas le contrôle.
33+
34+
Cette fonctionnalité vous permet aussi d'utiliser vos données sur différents périphériques (comme par exemple votre intelliphone **et** votre ordinateur).
35+
36+
## Sécurité
37+
38+
Si vous exposez votre base de donnée sur internet, vous devriez régler la sécurité sur l'interface de CouchDB.
39+
40+
Si vous lancez une autre web application locale qui utilise la même URL (http://localhost/) alors elle peut accéder à vos données de Lambda Badger (*nous allons étudier une option pour chiffrer les données dans une prochaine version*).

0 commit comments

Comments
 (0)