Refine documentation

Squashed commit of the following: commit f4831b0 Author: Kevin Bader <kevinbader@users.noreply.github.com> Date: Wed Apr 3 15:53:01 2019 +0200 Update readme commit ade5222 Author: Kevin Bader <kevinbader@users.noreply.github.com> Date: Wed Apr 3 14:22:44 2019 +0200 Increase Docker version to support managed volumes commit 5918232 Author: Kevin Bader <kevinbader@users.noreply.github.com> Date: Wed Apr 3 14:19:16 2019 +0200 Remove coverage badge commit 7e39d3d Author: Mathias Höld <mathias.hoeld@accenture.com> Date: Wed Apr 3 12:03:21 2019 +0200 Update screenshots for user guide commit 028d1f4 Merge: 96f255d 96cdbbf Author: Mathias Höld <mathias.hoeld@accenture.com> Date: Wed Apr 3 11:29:06 2019 +0200 Fix link commit 96f255d Author: Mathias Höld <mathias.hoeld@accenture.com> Date: Wed Apr 3 11:11:36 2019 +0200 Fix links in user guides commit 96cdbbf Author: Mathias Höld <mathias.hoeld@accenture.com> Date: Wed Apr 3 11:11:36 2019 +0200 Fix links in user guides commit 53a3014 Author: Stezido <stefan.ziffer@accenture.com> Date: Wed Apr 3 10:59:25 2019 +0200 Update 0007-execution-architecture-overview.md commit e408466 Author: Stezido <stefan.ziffer@accenture.com> Date: Wed Apr 3 10:58:34 2019 +0200 Update 0009-migration-model.md commit b427f2e Author: Stezido <stefan.ziffer@accenture.com> Date: Wed Apr 3 10:49:34 2019 +0200 Update README.md commit b2a444a Merge: f4031c4 db0020a Author: Mathias Höld <mathias.hoeld@accenture.com> Date: Wed Apr 3 10:41:18 2019 +0200 Merge and fix typos Add reference to multi node setup adr commit f4031c4 Author: Mathias Höld <mathias.hoeld@accenture.com> Date: Wed Apr 3 10:32:10 2019 +0200 Fix typos commit db0020a Author: Roman Schiefer <roman.schiefer@accenture.com> Date: Wed Apr 3 10:15:13 2019 +0200 doc: update table of contents commit 9880e90 Author: Roman Schiefer <roman.schiefer@accenture.com> Date: Wed Apr 3 10:10:25 2019 +0200 doc: mention the use of the tmp folder commit 5b40048 Author: Roman Schiefer <roman.schiefer@accenture.com> Date: Wed Apr 3 10:05:02 2019 +0200 doc: mention api in readme commit 86d70a3 Merge: f26bec4 84e1e37 Author: Mathias Höld <mathias.hoeld@accenture.com> Date: Wed Apr 3 09:10:15 2019 +0200 Merge remote-tracking branch 'origin/master' into readme-update commit f26bec4 Author: Roman Schiefer <roman.schiefer@accenture.com> Date: Wed Apr 3 08:50:51 2019 +0200 doc: added additional getting started content (not done yet) commit 8515060 Author: Roman Schiefer <roman.schiefer@accenture.com> Date: Tue Apr 2 21:36:54 2019 +0200 doc: added more details for the getting started example
openkfw · Apr 3, 2019 · 8f73025 · 8f73025
1 parent c64fe74
commit 8f73025
Show file tree

Hide file tree

Showing 16 changed files with 128 additions and 48 deletions.
diff --git a/README.md b/README.md
diff --git a/doc/adr/0007-execution-architecture-overview.md b/doc/adr/0007-execution-architecture-overview.md
@@ -1,4 +1,4 @@
-# 2. Basic architecture overview
+# 7. Basic architecture overview
 
 Date: 14/08/2018
 

diff --git a/doc/adr/0009-migration-model.md b/doc/adr/0009-migration-model.md
@@ -1,4 +1,4 @@
-# 8. Migration Model
+# 9. Migration Model
 
 Date: 28/11/2018
 
@@ -118,4 +118,4 @@ Before every write operation, the version needs to be checked. The most efficien
 ## Consequences
 - an upgraded node might disable all other nodes because nodes with an older version cannot read/write to the multichain in old data-versions
 - all items in any stream have a `dataVersion` field
-- version needs to be checked before every write operation
+- version needs to be checked before every write operation
diff --git a/doc/wiki/User-Guide/Projects/Project.md b/doc/wiki/User-Guide/Projects/Project.md
@@ -26,7 +26,7 @@ View all projects where the current user has view-permissions on.
 **Notes:**
 
 - An alternative way to view the projects site is to click on the Main Button in the upper left corner.
-- To view the project's details take a look at the [View project details section](<./#View project details>) below.
+- To view the project's details take a look at the [View project details section](#view-project-details) below.
 
 **Instructions:**
 
@@ -161,7 +161,7 @@ Close a project when all subprojects are closed.
 
 **Description:**
 
-The history contains all activities done directly refer to the current project and it's subprojects.
+The history contains all activities done directly refer to the current project and its subprojects.
 
 **Notes:**
 

diff --git a/doc/wiki/User-Guide/Projects/Subproject.md b/doc/wiki/User-Guide/Projects/Subproject.md
@@ -28,7 +28,7 @@ View all subprojects where the current user has view-permissions on.
 
 **Notes:**
 
-- To view the subproject's details take a look at the [View subproject details section](<./#View subproject details>) below.
+- To view the subproject's details take a look at the [View subproject details section](#view-subproject-details) below.
 
 **Instructions:**
 
@@ -86,9 +86,8 @@ Create a new subproject defining title, comment, currency and budget.
    - "Comment": A little description or comment refering to the subproject
    - "Organization": Organization that the budget belongs to
    - "Currency": The currency of the organization's budget
-   - "Amount": The amount of the organization's budget
 
-6. Add the budget of the organization by clicking the "+" symbol
+6. Add the projected budget of the organization by clicking the "+" symbol
    ![create a  project](../../uploads/Screenshots/add_subproject_2.jpeg)
    After this, the entered budget will appear on the screen
    ![create a  project](../../uploads/Screenshots/add_subproject_3.jpeg)
@@ -118,7 +117,6 @@ Update details like budget amount or title of a subproject.
    - "Subproject Title": Title of the subproject
    - "Comment": A little description or comment refering to the subproject
    - "Currency": Currency of the subproject
-   - "Subproject budget amount": Assigned budget to the subproject
 
 6. Click the "Submit"-button to update the subproject.
 
@@ -192,11 +190,12 @@ The additional data is a free field that can be used to extend the subproject da
 
 **Instructions:**
 
-1. Click the "i" button on the right side of the subproject
+1. Click the "..." button on the right side of the subproject
 2. A window appears containing the additional information on the subproject
 3. Close the window by clicking "close"
 
-![show subproject history](../../uploads/Screenshots/subproject_info.jpeg)
+![show subproject additional data](../../uploads/Screenshots/subproject_info.jpeg)
+![show subproject additional data screen](../../uploads/Screenshots/subproject_info_2.jpeg)
 
 ## [Permissions on subproject](../Permissions.md)
 

diff --git a/doc/wiki/User-Guide/Projects/Workflowitem.md b/doc/wiki/User-Guide/Projects/Workflowitem.md
@@ -220,7 +220,7 @@ Close a workflowitem when the work is done.
 
 **Description:**
 
-The [history of subprojects](<../Projects/Subproject#View the history of a subproject>) contains all activities refering to all it's workflowitems.
+The [history of subprojects](../Projects/Subproject#view-the-history-of-a-subproject) contains all activities refering to all it's workflowitems.
 
 ## Reorder Workflowitems
 

diff --git a/doc/wiki/User-Guide/Users-Groups/Group.md b/doc/wiki/User-Guide/Users-Groups/Group.md
@@ -66,7 +66,7 @@ Create a new group.
    - "Name": Name of group
 6. Type the user's ID into the field at the bottom of the dialog. After one or more characters are entered, a dropdown menu with suggested users will appear. Click the user in the dropdown to instantly add the user to the group. Note that the dropdown lists max. 6 user-suggestions - if the user you want to add is not visible in the dropdown, please enter more characters to search for the user. To remove any of the users that were already added, click the "X" next to the user's ID.
 
-Once a group is created you can grant and revoke administrator permissions for the group, more details can be found at [admin-permissions](./doc/wiki/User-Guide/Permissions.md#admin-permissions). 
+Once a group is created you can grant and revoke administrator permissions for the group, more details can be found at [admin-permissions](../Permissions.md#admin-permissions).
 
 ## Edit a Group
 

diff --git a/doc/wiki/User-Guide/Users-Groups/User.md b/doc/wiki/User-Guide/Users-Groups/User.md
@@ -1,6 +1,6 @@
 # User
 
-With **Users** an organization can grant an entity access to the Trubudget-application. New users only have access to the Trubudget-application without permissions to see any project. All permissions (e.g. view a project, view a subproject,...) have to be granted separately by the administrator. More details about the permission model can be found in the [Permissions section](<User guide/Users-Groups/Permissions>)
+With **Users** an organization can grant an entity access to the Trubudget-application. New users only have access to the Trubudget-application without permissions to see any project. All permissions (e.g. view a project, view a subproject,...) have to be granted separately by the administrator. More details about the permission model can be found in the [Permissions section](../Permissions.md)
 
 Users and Groups can be viewed and created in the "Users" section which can be found in the sidebar navigation.
 
@@ -48,5 +48,4 @@ Create a new User.
 
 5. Click the "Submit"-button to create and save the new user.
 
-
-Once a user is created you can grant and revoke administrator permissions for the user, more details can be found at [admin-permissions](./doc/wiki/User-Guide/Permissions.md#admin-permissions). 
+Once a user is created you can grant and revoke administrator permissions for the user, more details can be found at [admin-permissions](../Permissions.md#admin-permissions).
diff --git a/doc/wiki/uploads/Screenshots/add_project_3.jpeg b/doc/wiki/uploads/Screenshots/add_project_3.jpeg
diff --git a/doc/wiki/uploads/Screenshots/add_project_4.jpeg b/doc/wiki/uploads/Screenshots/add_project_4.jpeg
diff --git a/doc/wiki/uploads/Screenshots/add_project_5.jpeg b/doc/wiki/uploads/Screenshots/add_project_5.jpeg
diff --git a/doc/wiki/uploads/Screenshots/add_subproject_2.jpeg b/doc/wiki/uploads/Screenshots/add_subproject_2.jpeg
diff --git a/doc/wiki/uploads/Screenshots/add_subproject_3.jpeg b/doc/wiki/uploads/Screenshots/add_subproject_3.jpeg
diff --git a/doc/wiki/uploads/Screenshots/add_subproject_4.jpg b/doc/wiki/uploads/Screenshots/add_subproject_4.jpg
diff --git a/doc/wiki/uploads/Screenshots/subproject_info.jpeg b/doc/wiki/uploads/Screenshots/subproject_info.jpeg
diff --git a/doc/wiki/uploads/Screenshots/subproject_info_2.jpeg b/doc/wiki/uploads/Screenshots/subproject_info_2.jpeg