summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAaron Seigo <aseigo@kde.org>2015-12-31 19:00:03 +0100
committerAaron Seigo <aseigo@kde.org>2015-12-31 19:00:03 +0100
commita19884338f0cecb2c98215ddef54e3be09bf258b (patch)
tree2f53a85d043c7b92effe06329a178b1ed1705c8a
parent085a2f27086fc22ea984d7c57587d4d9de52c1c5 (diff)
downloadkube-a19884338f0cecb2c98215ddef54e3be09bf258b.tar.gz
kube-a19884338f0cecb2c98215ddef54e3be09bf258b.zip
use Kube in the docs
-rw-r--r--README.md12
-rw-r--r--docs/design.md8
-rw-r--r--docs/project.md4
-rw-r--r--docs/requirements.md4
4 files changed, 15 insertions, 13 deletions
diff --git a/README.md b/README.md
index fcf76dc8..9bc81d09 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,14 @@
1## Vision 1## Kube
2 2
3 Kontact Quick is a personal information manager for people who care about privacy and have email based workflows. It enables them to deal with large amounts of emails and coordinate teamwork in an effective way. 3Kube is a personal information and collaboration application currently in its early
4stages of development. It uses Akonadi Next for data access and synchronization, and
5leverages the KDE PIM codebase where possible.
4 6
5 We provide privacy by default and productivity in an elegant package. 7See doc/project.md for more information.
6
7 Unlike proprietary web applications it is Free Software and supports open standards. It gives you full control over your data and enables offline access.
8 8
9## License 9## License
10 10
11TBD 11TBD
12 12
13## Getting involved
14
diff --git a/docs/design.md b/docs/design.md
index 5d6d0754..122d83b6 100644
--- a/docs/design.md
+++ b/docs/design.md
@@ -1,7 +1,7 @@
1# Architecture / Design 1# Architecture / Design
2 2
3## Overview 3## Overview
4Kontact Quick is supposed to be a small and concise codebase that is easy to modify and evolve. 4Kube is supposed to be a small and concise codebase that is easy to modify and evolve.
5 5
6It's following a reactive model, where in one direction we have controllers generating modifications, and in the other direction models updating themselves on changes. 6It's following a reactive model, where in one direction we have controllers generating modifications, and in the other direction models updating themselves on changes.
7 7
@@ -23,7 +23,7 @@ The overall architecture is split into three layers; Ui, Domain Logic and Infras
23 23
24The UI Layer consists of views (mostly written in QML), view-models (models that are view specific and potentially implement user interaction details), and the glue code to use various controllers from the interface. Different UI layers may exist for different form factors. 24The UI Layer consists of views (mostly written in QML), view-models (models that are view specific and potentially implement user interaction details), and the glue code to use various controllers from the interface. Different UI layers may exist for different form factors.
25 25
26The domain logic layer holds the application state. It povides models to access data and controllers to act upon it. The domain logic is by definition Kontact Quick specific and not sharable with other applications, as it needs to be taylored exactly according to the requirements of Kontact Quick. 26The domain logic layer holds the application state. It povides models to access data and controllers to act upon it. The domain logic is by definition Kube specific and not sharable with other applications, as it needs to be taylored exactly according to the requirements of Kube.
27 27
28The infrastructure layer provides: 28The infrastructure layer provides:
29 29
@@ -142,9 +142,9 @@ Probably requires access to identities in some way.
142* KMime 142* KMime
143 143
144## Interaction with external applications 144## Interaction with external applications
145External applications, like the KDE calendar plasmoid, should be able to load parts of Kontact Quick when available. It should for instance be possible to load the Event editor as embeddable QML component, that is fully functional. That way it becomes very easy for third parties to provide extra functionality if Kontact Quick is installed, without having to reimplement the Domain Logic (as is the case if only data access is provided through akonadi). 145External applications, like the KDE calendar plasmoid, should be able to load parts of Kube when available. It should for instance be possible to load the Event editor as embeddable QML component, that is fully functional. That way it becomes very easy for third parties to provide extra functionality if Kube is installed, without having to reimplement the Domain Logic (as is the case if only data access is provided through akonadi).
146 146
147The same mechanism should probably be used by Kontact Quick itself to ensure loose coupling and allow mashups with various content types. 147The same mechanism should probably be used by Kube itself to ensure loose coupling and allow mashups with various content types.
148 148
149Note: We'll probably want a component-viewer application to easily load and test individual components (similar to plasmoidviewer). 149Note: We'll probably want a component-viewer application to easily load and test individual components (similar to plasmoidviewer).
150 150
diff --git a/docs/project.md b/docs/project.md
index 93e20f7f..a710eb1b 100644
--- a/docs/project.md
+++ b/docs/project.md
@@ -36,14 +36,14 @@ This section is supposed to outline that
36 * Better integration with kolab 36 * Better integration with kolab
37 37
38# Vision Statement 38# Vision Statement
39Kontact Quick aims to be an enterprise-ready PIM solution, that has a high-quality and rock solid core. The focus of the core is on high-quality code, maintainability, stability and performance. 39Kube aims to be an enterprise-ready PIM solution, that has a high-quality and rock solid core. The focus of the core is on high-quality code, maintainability, stability and performance.
40 40
41We strive to keep the core to the necessary minimum, with minimal dependencies and maximum portability, and in a way that it is maintainable by a small team. 41We strive to keep the core to the necessary minimum, with minimal dependencies and maximum portability, and in a way that it is maintainable by a small team.
42We also strive to keep the solution agile so that work by corporate partners can be executed upstream. 42We also strive to keep the solution agile so that work by corporate partners can be executed upstream.
43 43
44Experimental or advanced features are supported as optional addons, to not affect the high quality of the core product. 44Experimental or advanced features are supported as optional addons, to not affect the high quality of the core product.
45 45
46Kontact Quick aims to be available on various form-factors and platforms. 46Kube aims to be available on various form-factors and platforms.
47 47
48# Project Structure 48# Project Structure
49While this is an open project that welcomes participation from everyone who's interested, we do have an explicit team strucuture to ensure it's clear to everyone who's repsonsible for what. External contributions are always welcome and the team is of course open for extension. 49While this is an open project that welcomes participation from everyone who's interested, we do have an explicit team strucuture to ensure it's clear to everyone who's repsonsible for what. External contributions are always welcome and the team is of course open for extension.
diff --git a/docs/requirements.md b/docs/requirements.md
index c6b89e5c..75b43c8f 100644
--- a/docs/requirements.md
+++ b/docs/requirements.md
@@ -2,8 +2,8 @@
2Note: This is a draft only 2Note: This is a draft only
3 3
4## Roadwarrior 4## Roadwarrior
5* Fires up Kontact quickly to see what's up next (it's not constantly open) 5* Fires up Kube quickly to see what's up next (it's not constantly open)
6* Has to deal with bad/intermitted network connection 6* Has to deal with bad/intermittent network connection
7* Relies on offline capabilities to access content 7* Relies on offline capabilities to access content
8* Uses various mobile devices 8* Uses various mobile devices
9 9