aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/examples/ticket_tracker/README.rst9
-rw-r--r--docs/examples/ticket_tracker/aliases.sh9
-rw-r--r--docs/examples/ticket_tracker/settings.yaml26
3 files changed, 44 insertions, 0 deletions
diff --git a/docs/examples/ticket_tracker/README.rst b/docs/examples/ticket_tracker/README.rst
new file mode 100644
index 0000000..a767598
--- /dev/null
+++ b/docs/examples/ticket_tracker/README.rst
@@ -0,0 +1,9 @@
+###########
+ Our Tasks
+###########
+
+This is an example on how to use lesana to manage a personal / few users
+ticket tracker.
+
+The file ``aliases.sh`` can be sourced (``. ./aliases.sh``) to provide
+helpers for common searches.
diff --git a/docs/examples/ticket_tracker/aliases.sh b/docs/examples/ticket_tracker/aliases.sh
new file mode 100644
index 0000000..e2371e1
--- /dev/null
+++ b/docs/examples/ticket_tracker/aliases.sh
@@ -0,0 +1,9 @@
+#!/bin/sh
+
+LTT_STS_OPEN='status:planned status:ready status:"in progress" status:comments'
+LTT_STS_ACTIVE='status:"in progress" status:comments'
+LTT_STS_CLOSED='status:done status:invalid'
+
+alias ltt-s-open="lesana search $LTT_STS_OPEN"
+alias ltt-s-active="lesana search $LTT_STS_ACTIVE"
+alias ltt-s-closed="lesana search $LTT_STS_CLOSED"
diff --git a/docs/examples/ticket_tracker/settings.yaml b/docs/examples/ticket_tracker/settings.yaml
new file mode 100644
index 0000000..67e87d0
--- /dev/null
+++ b/docs/examples/ticket_tracker/settings.yaml
@@ -0,0 +1,26 @@
+name: Our tasks
+lang: english
+entry_label: '{{ short_id }}: {{ name }} [{{ status }}]'
+git: true
+fields:
+- name: name
+ type: string
+ prefix: S
+ index: free
+- name: description
+ type: text
+ index: free
+- name: status
+ type: text
+ index: field
+ help: planned|ready|in progress|comments|done|invalid
+ sortable: true
+- name: assignee
+ type: string
+ index: field
+ help: insert your list of potential assignees here
+- name: comments
+ type: list
+ list: text
+ index: free
+