From e1b7e8013f725d8b73e94c3b69a143b412c608d8 Mon Sep 17 00:00:00 2001
From: Frédéric Guillot <fguillot@users.noreply.github.com>
Date: Sun, 16 Mar 2014 13:50:40 -0400
Subject: Add more documentation

---
 docs/sqlite-database.markdown |  50 +++++++++++++++
 docs/syntax-guide.markdown    | 138 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 188 insertions(+)
 create mode 100644 docs/sqlite-database.markdown
 create mode 100644 docs/syntax-guide.markdown

(limited to 'docs')

diff --git a/docs/sqlite-database.markdown b/docs/sqlite-database.markdown
new file mode 100644
index 00000000..0a6a0ab6
--- /dev/null
+++ b/docs/sqlite-database.markdown
@@ -0,0 +1,50 @@
+Sqlite database management
+==========================
+
+Kanboard uses Sqlite by default to store its data.
+All tasks, projects and users are stored inside this database.
+
+Technically, the database is just a single file located inside the directory `data` and named `db.sqlite`.
+
+Export/Backup
+-------------
+
+### Command line
+
+Doing a backup is very easy, just copy the file `data/db.sqlite` somewhere else when nobody use the software.
+
+### User interface
+
+You can also download at any time the database directly from the **settings** menu.
+
+The downloaded database is compressed with Gzip, the filename becomes `db.sqlite.gz`.
+
+Import/Restoration
+------------------
+
+There is actually no way to restore the database from the user interface.
+The restoration must be done manually when no body use the software.
+
+- To restore an old backup, just replace and overwrite the actual file `data/db.sqlite`.
+- To uncompress a gzipped database, execute this command from a terminal `gunzip db.sqlite.gz`.
+
+Optimization
+------------
+
+Occasionally, it's possible to optimize the database file by running the command `VACUUM`.
+This command rebuild the entire database and can be used for several reasons:
+
+- Reduce the file size, deleting data produce empty space but doesn't change the file size.
+- The database is fragmented due to frequent inserts or updates.
+
+### From the command line
+
+```
+sqlite3 data/db.sqlite 'VACUUM'
+```
+
+### From the user interface
+
+Go to the menu **settings** and click on the link **Optimize the database**.
+
+For more information, read the [Sqlite documentation](https://sqlite.org/lang_vacuum.html).
diff --git a/docs/syntax-guide.markdown b/docs/syntax-guide.markdown
new file mode 100644
index 00000000..b65c63e5
--- /dev/null
+++ b/docs/syntax-guide.markdown
@@ -0,0 +1,138 @@
+Syntax Guide
+============
+
+Kanboard use the [Markdown syntax](http://en.wikipedia.org/wiki/Markdown) to write comments or tasks description.
+Here are some examples:
+
+Bold and italic
+----------------
+
+- Bold text: Use 2 asterisks or 2 underscores
+- Italic text: Use 1 asterisk or 1 underscore
+
+### Source
+```
+This **word** is very __important__.
+
+And here, an *italic* word with one _underscore_.
+```
+
+### Result
+
+This **word** is very __important__.
+
+And here, an *italic* word with one _underscore_.
+
+Unordered Lists
+---------------
+
+Unordered list can use asterisks, minuses or pluses.
+
+### Source
+
+```
+- Item 1
+- Item 2
+- Item 3
+
+or
+
+* Item 1
+* Item 2
+* Item 3
+```
+
+### Result
+
+- Item 1
+- Item 2
+- Item 3
+
+Ordered lists
+-------------
+
+Ordered lists are prefixed by a number like that:
+
+### Source
+
+```
+1. Do that first
+2. Do this
+3. And that
+```
+
+### Result
+
+1. Do that first
+2. Do this
+3. And that
+
+Links
+-----
+
+### Source
+
+```
+[My link title](http://kanboard.net/)
+
+<http://kanboard.net>
+
+```
+
+### Result
+
+[My link title](http://kanboard.net/)
+
+<http://kanboard.net>
+
+Source code
+-----------
+
+### Inline code
+
+Use a backtick.
+
+```
+Execute this command: `tail -f /var/log/messages`.
+```
+
+### Result
+
+Execute this command: `tail -f /var/log/messages`.
+
+### Code blocks
+
+Use 3 backticks with eventually the language name.
+
+<pre>
+```php
+&lt;?php
+
+phpinfo();
+
+?&gt;
+```
+</pre>
+
+### Result
+
+```
+<?php
+
+phpinfo();
+
+?>
+```
+
+Titles
+------
+
+### Source
+
+```
+# Title level 1
+
+## Title level 2
+
+### Title level 3
+```
-- 
cgit v1.2.3