[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    [kontact-quick/feature/kubification] /: use Kube in the docs
From:       Aaron Seigo <aseigo () kde ! org>
Date:       2015-12-31 18:09:24
Message-ID: E1aEhfA-0007el-Ji () scm ! kde ! org
[Download RAW message or body]

Git commit a19884338f0cecb2c98215ddef54e3be09bf258b by Aaron Seigo.
Committed on 31/12/2015 at 18:00.
Pushed by aseigo into branch 'feature/kubification'.

use Kube in the docs

M  +7    -5    README.md
M  +4    -4    docs/design.md
M  +2    -2    docs/project.md
M  +2    -2    docs/requirements.md

http://commits.kde.org/kontact-quick/a19884338f0cecb2c98215ddef54e3be09bf25=
8b

diff --git a/README.md b/README.md
index fcf76dc..9bc81d0 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,14 @@
-## Vision
+## Kube
 =

-  Kontact Quick is a personal information manager for people who care abou=
t privacy and have email based workflows. It enables them to deal with larg=
e amounts of emails and coordinate teamwork in an effective way.
+Kube is a personal information and collaboration application currently in =
its early
+stages of development. It uses Akonadi Next for data access and synchroniz=
ation, and
+leverages the KDE PIM codebase where possible.
 =

-  We provide privacy by default and productivity in an elegant package.
-
-  Unlike proprietary web applications it is Free Software and supports ope=
n standards. It gives you full control over your data and enables offline a=
ccess.
+See doc/project.md for more information.
 =

 ## License
 =

 TBD
 =

+## Getting involved
+
diff --git a/docs/design.md b/docs/design.md
index 5d6d075..122d83b 100644
--- a/docs/design.md
+++ b/docs/design.md
@@ -1,7 +1,7 @@
 # Architecture / Design
 =

 ## Overview
-Kontact Quick is supposed to be a small and concise codebase that is easy =
to modify and evolve.
+Kube is supposed to be a small and concise codebase that is easy to modify=
 and evolve.
 =

 It's following a reactive model, where in one direction we have controller=
s generating modifications, and in the other direction models updating them=
selves on changes.
 =

@@ -23,7 +23,7 @@ The overall architecture is split into three layers; Ui, =
Domain Logic and Infras
 =

 The UI Layer consists of views (mostly written in QML), view-models (model=
s that are view specific and potentially implement user interaction details=
), and the glue code to use various controllers from the interface. Differe=
nt UI layers may exist for different form factors.
 =

-The domain logic layer holds the application state. It povides models to a=
ccess data and controllers to act upon it. The domain logic is by definitio=
n Kontact Quick specific and not sharable with other applications, as it ne=
eds to be taylored exactly according to the requirements of Kontact Quick.
+The domain logic layer holds the application state. It povides models to a=
ccess data and controllers to act upon it. The domain logic is by definitio=
n Kube specific and not sharable with other applications, as it needs to be=
 taylored exactly according to the requirements of Kube.
 =

 The infrastructure layer provides:
 =

@@ -142,9 +142,9 @@ Probably requires access to identities in some way.
 * KMime
 =

 ## Interaction with external applications
-External applications, like the KDE calendar plasmoid, should be able to l=
oad parts of Kontact Quick when available. It should for instance be possib=
le to load the Event editor as embeddable QML component, that is fully func=
tional. That way it becomes very easy for third parties to provide extra fu=
nctionality if Kontact Quick is installed, without having to reimplement th=
e Domain Logic (as is the case if only data access is provided through akon=
adi).
+External applications, like the KDE calendar plasmoid, should be able to l=
oad parts of Kube when available. It should for instance be possible to loa=
d the Event editor as embeddable QML component, that is fully functional. T=
hat way it becomes very easy for third parties to provide extra functionali=
ty if Kube is installed, without having to reimplement the Domain Logic (as=
 is the case if only data access is provided through akonadi).
 =

-The same mechanism should probably be used by Kontact Quick itself to ensu=
re loose coupling and allow mashups with various content types.
+The same mechanism should probably be used by Kube itself to ensure loose =
coupling and allow mashups with various content types.
 =

 Note: We'll probably want a component-viewer application to easily load an=
d test individual components (similar to plasmoidviewer).
 =

diff --git a/docs/project.md b/docs/project.md
index 93e20f7..a710eb1 100644
--- a/docs/project.md
+++ b/docs/project.md
@@ -36,14 +36,14 @@ This section is supposed to outline that
     * Better integration with kolab
 =

 # Vision Statement
-Kontact 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.
+Kube 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, maintai=
nability, stability and performance.
 =

 We strive to keep the core to the necessary minimum, with minimal dependen=
cies and maximum portability, and in a way that it is maintainable by a sma=
ll team.
 We also strive to keep the solution agile so that work by corporate partne=
rs can be executed upstream.
 =

 Experimental or advanced features are supported as optional addons, to not=
 affect the high quality of the core product.
 =

-Kontact Quick aims to be available on various form-factors and platforms.
+Kube aims to be available on various form-factors and platforms.
 =

 # Project Structure
 While this is an open project that welcomes participation from everyone wh=
o'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 c6b89e5..75b43c8 100644
--- a/docs/requirements.md
+++ b/docs/requirements.md
@@ -2,8 +2,8 @@
 Note: This is a draft only
 =

 ## Roadwarrior
-* Fires up Kontact quickly to see what's up next (it's not constantly open)
-* Has to deal with bad/intermitted network connection
+* Fires up Kube quickly to see what's up next (it's not constantly open)
+* Has to deal with bad/intermittent network connection
 * Relies on offline capabilities to access content
 * Uses various mobile devices
 =


[prev in list] [next in list] [prev in thread] [next in thread]