-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Alessandro
committed
May 18, 2018
1 parent
88ad5d9
commit e4f5442
Showing
1 changed file
with
19 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,44 @@ | ||
| Documentation structure | ||
| Before starting | ||
| =========================== | ||
|
|
||
| Documentation structure | ||
| ----------------- | ||
|
|
||
| Knowage documentation is composed by: | ||
|
|
||
| - **Installation Manual**; | ||
|
|
||
| - **General User Manual**; | ||
|
|
||
| - **General Administrator Manual**; | ||
|
|
||
| - one more book for each product purchased. | ||
|
|
||
| The books focusing on products describe all the BI functionalities | ||
| included in your installation. For example if you have purchased | ||
| KnowageBD subscription, you will get the installation and the two | ||
| general manuals plus a third one which focus on the BI functionalities | ||
| provided by this product. | ||
| The books focusing on products describe all the BI functionalities included in your installation. For example if you have purchased KnowageBD subscription, you will get the installation and the two general manuals plus a third one which focus on the BI functionalities provided by this product. | ||
|
|
||
| Target | ||
| ====== | ||
| ----------------- | ||
|
|
||
| Each book is thought to be delivered to different users. | ||
|
|
||
| - **Installation Manual**: it is aimed at technical users. It provides | ||
| all the instructions needed to install and configure the Knowage | ||
| suite. Here the essential steps to succeed with the standard | ||
| installation on certified environments will be described, including | ||
| the optional use of CAS as a SSO solution and the use of HTTPS | ||
| protocol. | ||
|
|
||
| - **General User Manual**: it is aimed at end users. It provides a | ||
| first approach to Knowage interface and functionalities. It can be | ||
| used as a first approach to Knowage. It focus on all those elements | ||
| which are shared among the products and involves the end user. | ||
|
|
||
| - **General Administrator Manual**: it is aimed at Knowage | ||
| admnistrator. It describes all the management and configuration tools | ||
| shared by all Knowage products. | ||
|
|
||
| - **Product Manuals**: as we mentioned above, these books are specific | ||
| for each product. They are aimed both at end users and Knowage | ||
| developers. Almost each chapter is divided in two parts: the first | ||
| one can be interesting for both users and developers, while the | ||
| second one is for developers only. The developer parts are marked by | ||
| a \* to be easy recognised. We can conlcude that you just need to | ||
| read all the parts not marked by \* to have a complete introduction | ||
| to all BI functionalities included in your products. | ||
| - **Installation Manual**: it is aimed at technical users. It provides all the instructions needed to install and configure the Knowage suite. Here the essential steps to succeed with the standard installation on certified environments will be described, including the optional use of CAS as a SSO solution and the use of HTTPS protocol. | ||
|
|
||
| - **General User Manual**: it is aimed at end users. It provides a first approach to Knowage interface and functionalities. It can be used as a first approach to Knowage. It focus on all those elements which are shared among the products and involves the end user. | ||
|
|
||
| - **General Administrator Manual**: it is aimed at Knowage admnistrator. It describes all the management and configuration tools shared by all Knowage products. | ||
|
|
||
| - **Product Manuals**: as we mentioned above, these books are specific for each product. They are aimed both at end users and Knowage developers. Almost each chapter is divided in two parts: the first one can be interesting for both users and developers, while the second one is for developers only. The developer parts are marked by a \* to be easy recognised. We can conlcude that you just need to | ||
| read all the parts not marked by \* to have a complete introduction to all BI functionalities included in your products. | ||
|
|
||
| About conventions | ||
| ================= | ||
| ----------------- | ||
|
|
||
| Some graphical conventions have been adopted to allow readers to easily | ||
| identify special contents such as notes, summaries and essential | ||
| information. All conventions are explained hereafter. | ||
| Some graphical conventions have been adopted to allow readers to easily identify special contents such as notes, summaries and essential information. All conventions are explained hereafter. | ||
|
|
||
| |image0| | ||
|
|
||
| Documentation structure | ||
|
|
||
|
|
||
| The following fonts have been adopted, to easily identify special words | ||
| and expressions: | ||
|
|
||
| - **Menu**, **Menu items** and **static label** refer to specific | ||
| element of Knowage GUI; | ||
|
|
||
| - **Menu**, **Menu items** and **static label** refer to specific element of Knowage GUI; | ||
| - Input field is a label referencing input fields in Knowage GUI; | ||
|
|
||
| - Code example is a piece of code showing configuration patterns or | ||
| parts of document template. | ||
|
|
||
| .. | ||
| - Code example is a piece of code showing configuration patterns or parts of document template. |