Skip to content

Commit

Permalink
Add missing document templates analytics
Browse files Browse the repository at this point in the history
  • Loading branch information
krystofkomanec committed Jan 8, 2025
1 parent 1f1e34f commit 13c7867
Show file tree
Hide file tree
Showing 6 changed files with 78 additions and 28 deletions.
51 changes: 51 additions & 0 deletions docs/applications/analytics/document-templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,54 @@

Document Templates
******************

As an administrator, we can view analytics of document templates. We can create and edit views by selecting from many different fields and see how our document templates are doing. The view can be modified and save to be reviewed later. The data can also be exported to a CSV file.

.. TODO::

Add screenshot of the Document Templates overview.

.. figure:: document-templates/overview.png
:width: 700

Document Templates overview.


New view can be created by clicking on the dropdown menu in the top right corner. Then by clicking on :guilabel:`+ Create a new view` we open the view settings. We can give our view a name and select which fields we want to have in there. The view can be saved by clicking on :guilabel:`Save`. We can also delete the view by clicking on :guilabel:`Delete`.

.. figure:: document-templates/settings.png
:width: 400

Form for editing analytics view.


Various fields have filters that can be used to narrow down the data.

We can also resize all rows height by clicking on the double arrow in the top left corner. If we want to edit width or height of individual cells, we can do it using drag-and-drop on the borders. Lastly we can edit how many rows are on the page by clicking on the :guilabel:`Items per page` dropdown menu.

.. NOTE::

Don't forget to click on :guilabel:`Save` icon after you are done with editing the view.


The data of a view can be exported to a CSV file by clicking on :guilabel:`Export CSV`.

Document templates details
--------------------------

By clicking on the document template name, we can open that document template detail. The document template detail has three tabs and details. The tabs are as follows:

- Readme
- Projects
- Documents

The :guilabel:`Readme` tab shows readme file of the selected document template. The :guilabel:`Projects` tab shows all projects created using selected document template. The :guilabel:`Documents` tab shows all Documents that were generated using the selected document template, across all projects.

The document template details on the right side show additional document template metadata, such as ID, description, version, publisher, formats and knowledge models it can be used with.

Lastly we can click on the :guilabel:`Open in Data Management Planner` button to open the actual document template.

.. TODO::

Add screenshot of the document template detail.

2 changes: 1 addition & 1 deletion docs/applications/analytics/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Analytics
*********

Analytics is an application that gathers data from other applications and is used to view that data in comfortable and customizable way. Data is gathered from :ref:`projects<projects>`, :ref:`users<user-list>` and :ref:`user groups<user-groups>`.
Analytics is an application that gathers data from other applications and is used to view that data in comfortable and customizable way. The data is gathered from :ref:`Knowledge Models<knowledge-models>`, :ref:`Document Templates<document-templates>`, :ref:`projects<projects>`, :ref:`users<user-list>` and :ref:`user groups<user-groups>`.

To get latest data, click on :guilabel:`Synchronize Data` button. This will synchronize the data from the other apps and store it in the analytics database. Once the data has been updated, the page will automatically refresh.

Expand Down
14 changes: 7 additions & 7 deletions docs/applications/analytics/knowledge-models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,32 +30,32 @@ The data of a view can be exported to a CSV file by clicking on :guilabel:`Expor
Don't forget to click on :guilabel:`Save` icon after you are done with editing the view.


Knowledge Model details
Knowledge model details
-----------------------

By clicking on the Knowledge Model id or name, wew can open that Knowledge Model detail. If we choose to click on a certain version of a Knowledge Model, that specific versions detail will open. The Knowledge Model detail has four tabs and details. The tabs are as follows:
By clicking on the knowledge model ID or name, wew can open that knowledge model detail. If we choose to click on a certain version of a knowledge model, that specific versions detail will open. The knowledge model detail has four tabs and details. The tabs are as follows:

- Readme
- Projects
- KM Editors
- Insights

The :guilabel:`Readme` tab shows the exact information that we can see in the Knowledge Model Detail within the Data Management Planner. The :guilabel:`Projects` tab shows all Projects that are using the selected Knowledge Model. The :guilabel:`KM Editors` tab shows all Knowledge Model Editors that are using the selected Knowledge Model. Both of these tabs also display numbers next to them, representing the number of created Projects or Knowledge Model Editors.
The :guilabel:`Readme` tab shows the exact information that we can see in the knowledge model detail within the Data Management Planner. The :guilabel:`Projects` tab shows all projects that are using the selected knowledge model. The :guilabel:`KM editors` tab shows all knowledge model editors that are using the selected knowledge model. Both of these tabs also display numbers next to them, representing the number of created projects or knowledge model editors.

.. figure:: knowledge-models/km-editors.png

Knowledge Model Editors created using this Knowledge Model.
Knowledge model editors created using this knowledge model.


The last tab, :guilabel:`Insights`, is the most complex. It shows us detailed information for each question and answer, such as the number of times a certain question was displayed to users and how these questions were answered. If we are viewing details of a value question, we can use search functionality to find the value we are interested in.

Furthermore, we can also open various questions to see insights into how the Researchers are answering them.

The Knowledge Model details on the right side show additional Knowledge Model metadata, such as ID, Description, License and Version.
The knowledge model details on the right side show additional knowledge model metadata, such as ID, description, license and version.

Lastly we can click on the :guilabel:`Open in Data Management Planner` button to open the actual Knowledge Model.
Lastly we can click on the :guilabel:`Open in Data Management Planner` button to open the actual knowledge model.

.. figure:: knowledge-models/insights.png

Insights to usage of this Knowledge Model in Projects.
Insights to usage of this knowledge model in projects.

10 changes: 5 additions & 5 deletions docs/applications/analytics/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,20 @@ The data of a view can be exported to a CSV file by clicking on :guilabel:`Expor
Project details
---------------

By clicking on the Project name, we can open that Project detail. The Project detail has four tabs and details. The tabs are as follows:
By clicking on the project name, we can open that project detail. The project detail has four tabs and details. The tabs are as follows:

- Metrics
- Users
- User Groups
- Documents

The :guilabel:`Metrics` tab shows all metrics that are used in the selected Project. We can also see contributors, who is contributing to the Project, when and what is the share of contributions. The :guilabel:`Users` tab shows all Users that are part of the selected Project and their roles. The :guilabel:`User Groups` tab shows all User Groups that are part of the selected Project and their role. The :guilabel:`Documents` tab shows all Documents that were generated using the Project. There are also other Document metadata, such as format, size, and author.
The :guilabel:`Metrics` tab shows all metrics that are used in the selected project. We can also see contributors, who is contributing to the project, when and what is the share of contributions. The :guilabel:`Users` tab shows all users that are part of the selected project and their roles. The :guilabel:`User Groups` tab shows all user groups that are part of the selected project and their role. The :guilabel:`Documents` tab shows all documents that were generated using the project. There are also other document metadata, such as format, size, and author.

The Project details on the right side show additional Project metadata, such as Description, Phase, Sharing options, numbers of Comments and TODOs, Project Tags, Knowledge Model and Questions Tags.
The project details on the right side show additional project metadata, such as description, phase, sharing options, numbers of comments and TODOs, project tags, knowledge model and questions tags.

Lastly we can click on the :guilabel:`Open in Data Management Planner` button to open the actual Project.
Lastly we can click on the :guilabel:`Open in Data Management Planner` button to open the actual project.

.. TODO::

Add screenshot of the Project detail.
Add screenshot of the project detail.

16 changes: 8 additions & 8 deletions docs/applications/analytics/user-groups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
User Groups
***********

As an administrator, we can view analytics of User Groups. We can create and edit views by selecting from many different fields and see how our projects are doing. The view can be modified and save to be reviewed later. The data can also be exported to a CSV file.
As an administrator, we can view analytics of ser Groups. We can create and edit views by selecting from many different fields and see how our projects are doing. The view can be modified and save to be reviewed later. The data can also be exported to a CSV file.

.. figure:: user-groups/overview.png

User Groups Overview.
User groups overview.


New view can be created by clicking on the dropdown menu in the top right corner. Then by clicking on :guilabel:`+ Create a new view` we open the view settings. We can give our view a name and select which fields we want to have in there. The view can be saved by clicking on :guilabel:`Save`. We can also delete the view by clicking on :guilabel:`Delete`.
Expand All @@ -29,20 +29,20 @@ The data of a view can be exported to a CSV file by clicking on :guilabel:`Expor
Don't forget to click on :guilabel:`Save` icon after you are done with editing the view.


User Group details
User group details
------------------

By clicking on the User Group name, we can open the User Group details. The User Group detail has two tabs and details. The tabs are as follows:
By clicking on the user group name, we can open the user group details. The user group detail has two tabs and details. The tabs are as follows:

- Members
- Projects

The :guilabel:`Members` and :guilabel:`Projects` tabs show the number of respective items. In the :guilabel:`Members` tab, we can see the members of the Group and their role. In the :guilabel:`Projects` tab, we can see the projects that have the Group assigned, as well as the role assigned to the User Group.
The :guilabel:`Members` and :guilabel:`Projects` tabs show the number of respective items. In the :guilabel:`Members` tab, we can see the members of the group and their role. In the :guilabel:`Projects` tab, we can see the projects that have the group assigned, as well as the role assigned to the user group.

.. figure:: user-groups/detail.png

Form for editing analytics view.
Form for editing Analytics view.

The User Group details on the right side show User Group metadata, such as the description or date created.
The user group details on the right side show user group metadata, such as the description or date created.

Lastly we can click on the :guilabel:`Open in Admin Center` button to open the actual Knowledge Model.
Lastly we can click on the :guilabel:`Open in Admin Center` button to open the actual knowledge model.
13 changes: 6 additions & 7 deletions docs/applications/analytics/users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Users
*****

As an administrator, we can view analytics of Users. We can select from many different fields and see how our Users are doing. The view can be modified and save to be reviewed later. The data can also be exported to a CSV file.
As an administrator, we can view analytics of users. We can select from many different fields and see how our users are doing. The view can be modified and save to be reviewed later. The data can also be exported to a CSV file.

.. figure:: users/overview.png
:width: 700
Expand Down Expand Up @@ -33,18 +33,17 @@ The data of a view can be exported to a CSV file by clicking on :guilabel:`Expor
User details
------------

By clicking on the first or last name of a User, we can open that User detail. The User detail has two tabs and details. The tabs are as follows:
By clicking on the first or last name of a user, we can open that user detail. The user detail has two tabs and details. The tabs are as follows:

- Projects
- User Groups
- user Groups

The :guilabel:`Projects` and :guilabel:`User Groups` tabs show the number of respective items. In the :guilabel:`Projects` tab we can the list of Projects which this User is part of and their role in the Project. In the :guilabel:`User Groups` tab we can see list of User Groups this User is member or owner of and the Group visibility.
The :guilabel:`Projects` and :guilabel:`User Groups` tabs show the number of respective items. In the :guilabel:`Projects` tab we can the list of projects which this user is part of and their role in the project. In the :guilabel:`user Groups` tab we can see list of user groups this user is member or owner of and the group visibility.

The User details on the right side shows additional User metadata, such as Role, Email, or Affiliation.
The user details on the right side shows additional user metadata, such as role, email, or affiliation.

Lastly we can click on the :guilabel:`Open in Admin Center` button to open the actual User.
Lastly we can click on the :guilabel:`Open in Admin Center` button to open the actual user.

.. figure:: users/detail.png

User detail.

0 comments on commit 13c7867

Please sign in to comment.