Skip to content

Commit

Permalink
Merge branch 'hotfix/move-documents-under-projects' into preview
Browse files Browse the repository at this point in the history
  • Loading branch information
krystofkomanec committed Jan 23, 2025
2 parents d18f39c + cb3b79a commit b1cbfbb
Show file tree
Hide file tree
Showing 31 changed files with 50 additions and 33 deletions.
4 changes: 2 additions & 2 deletions docs/about/introduction/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ Documents are produced from the questionnaire answers and a document template. T
Admin Center
============

The Admin Center is an application in which can administrators manage the FAIR Wizard application. This includes management of users, their roles and user groups and various imports. It also includes the management of the application itself. User groups can also be managed by data stewards.
The Admin Center is an application in which can admins manage the FAIR Wizard application. This includes management of users, their roles and user groups and various imports. It also includes the management of the application itself. User groups can also be managed by data stewards.

Users
-----

Users are people who use the FAIR Wizard. They can be researchers, data stewards, or administrators. Each user has a role that defines what they can do in the application. Users can be organized into user groups.
Users are people who use the FAIR Wizard. They can be researchers, data stewards, or admins. Each user has a role that defines what they can do in the application. Users can be organized into user groups.

:ref:`Learn more about users →<user-list>`

Expand Down
4 changes: 2 additions & 2 deletions docs/applications/admin-center/audit-log/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
Audit Log
*********

Audit log is a feature that allows administrators to track everything that is happening in the FAIR Wizard.
Audit log is a feature that allows admins to track everything that is happening in the FAIR Wizard.

.. NOTE::

For now, Audit log is available for Admin Center, Analytics and Integration Hub. Data Management Planner will be added in the future updates.
For now, audit log is available for Admin Center, Analytics and Integration Hub. Data Management Planner will be added in the future updates.


List can be searched based using content of audit logs. The dropdown menu can be used to select which app logs we want to display. Then we can also select which component we want to see. In the list we can see what particular action has been done, who did it and when it happened.
Expand Down
2 changes: 1 addition & 1 deletion docs/applications/admin-center/import/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Import
******

As an administrator, we can import users and projects using provided templates.
As an admin, we can import users and projects using provided templates.

.. figure:: index/index.png

Expand Down
2 changes: 1 addition & 1 deletion docs/applications/admin-center/import/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Projects Import
***************

As an administrator, we can import projects using provided template. The template has four columns: name, knowledgeModelId, documentTemplateId and emails of users we want to add as owners to a project. Once it is filled with data, we can import it back to the FAIR Wizard to populate it with projects.
As an admin, we can import projects using provided template. The template has four columns: name, knowledgeModelId, documentTemplateId and emails of users we want to add as owners to a project. Once it is filled with data, we can import it back to the FAIR Wizard to populate it with projects.

.. figure:: projects/projects.png
:width: 528
Expand Down
2 changes: 1 addition & 1 deletion docs/applications/admin-center/import/users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Users Import
************

As an administrator we can import users using provided template. The template has five columns: email, firstName, lastName, affiliation and role. Once it is filled with data, we can import it back to the FAIR Wizard to populate it with users.
As an admin we can import users using provided template. The template has five columns: email, firstName, lastName, affiliation and role. Once it is filled with data, we can import it back to the FAIR Wizard to populate it with users.

.. figure:: users/users.png
:width: 528
Expand Down
2 changes: 1 addition & 1 deletion docs/applications/admin-center/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Admin Center
************

Admin Center is an application for management of the FAIR Wizard application and users within it. This application is mainly used for administration by **administrators**. It is used for users and user groups management, import of data, and settings management. User groups can also be managed by **data stewards**.
Admin Center is an application for management of the FAIR Wizard application and users within it. This application is mainly used for administration by **admins**. It is used for users and user groups management, import of data, and settings management. User groups can also be managed by **data stewards**.

----

Expand Down
2 changes: 1 addition & 1 deletion docs/applications/admin-center/user-groups/create.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Create
******

As an administrator, we can create a new user group. For the user group we must set its name and optionally its description. We can also set the group as either a public or private group. Public groups are visible to all users, while private groups are only visible to the group members.
As an admin, we can create a new user group. For the user group we must set its name and optionally its description. We can also set the group as either a public or private group. Public groups are visible to all users, while private groups are only visible to the group members.

.. figure:: create/create.png
:width: 450
Expand Down
2 changes: 1 addition & 1 deletion docs/applications/admin-center/user-groups/detail.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
User Group Detail
*****************

As an administrator, we can manage existing user group from User Group Settings. We can change name and description of a group and make it private. If a group is private, then only its members and application admins can see it.
As an admin, we can manage existing user group from User Group Settings. We can change name and description of a group and make it private. If a group is private, then only its members and application admins can see it.

.. figure:: detail/info.png
:width: 528
Expand Down
2 changes: 1 addition & 1 deletion docs/applications/admin-center/user-groups/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
User Groups
***********

As a data steward or an administrator, we can create a user group. The group can be used to add multiple people to a project at once. A group can be selected in :ref:`sharing settings<sharing>` of a project.
As a data steward or an admin, we can create a user group. The group can be used to add multiple people to a project at once. A group can be selected in :ref:`sharing settings<sharing>` of a project.

User Groups list allows us to see and manage all user groups in the FAIR Wizard. The list can be searched based using name fragment, and sorted via properties of user groups, name and date created.

Expand Down
2 changes: 1 addition & 1 deletion docs/applications/admin-center/users/detail.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
User Detail
***********

As administrators, we can edit existing users manually on the detail (selected user from the :ref:`users list<user-list>`). It is possible to change all properties of the user, including possibility to change whether the user account is active or inactive.
As admins, we can edit existing users manually on the detail (selected user from the :ref:`users list<user-list>`). It is possible to change all properties of the user, including possibility to change whether the user account is active or inactive.

.. figure:: detail/profile.png
:width: 528
Expand Down
4 changes: 2 additions & 2 deletions docs/applications/admin-center/users/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Users
*****

Users list allows administrators to see and manage all users in the FAIR Wizard. The list can be filtered using role, searched using name or email fragment, and sorted via various properties of users. The list shows the role of a user next to its name and also indicates in case the user is inactive. Next to the email, we can quickly see what authentication services the user uses to log-in (:guilabel:`internal` is the internal authentication with email-password credentials, other are based on configured :ref:`OpenID services<auth-services>`).
User list allows admins to see and manage all users in the FAIR Wizard. The list can be filtered using role, searched using name or email fragment, and sorted via various properties of users. The list shows the role of a user next to its name and also indicates in case the user is inactive. Next to the email, we can quickly see what authentication services the user uses to log-in (:guilabel:`internal` is the internal authentication with email-password credentials, other are based on configured :ref:`OpenID services<auth-services>`).

A :ref:`user detail<user-detail>` can be opened by clicking the name of a user or by selecting :guilabel:`Edit` in the right dropdown menu for the desired row. There, a user can be also deleted via the :guilabel:`Delete` action. Finally, administrator can :ref:`invite a new user<user-invite>` by clicking :guilabel:`Invite`, or :ref:`import users<import-users>` by clicking :guilabel:`Import`.
A :ref:`user detail<user-detail>` can be opened by clicking the name of a user or by selecting :guilabel:`Edit` in the right dropdown menu for the desired row. There, a user can be also deleted via the :guilabel:`Delete` action. Finally, admin can :ref:`invite a new user<user-invite>` by clicking :guilabel:`Invite`, or :ref:`import users<import-users>` by clicking :guilabel:`Import`.

.. figure:: index/list.png

Expand Down
4 changes: 2 additions & 2 deletions docs/applications/admin-center/users/invite.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Invite User
***********

As administrators, we can create new users manually by clicking :guilabel:`Invite` on the :ref:`users list<user-list>` and submitting the form. Each user must have a unique email address, first name and last name and assigned :ref:`role<user-roles>`. Optionally, a user can have affiliation specified.
As admins, we can create new users manually by clicking :guilabel:`Invite` on the :ref:`users list<user-list>` and submitting the form. Each user must have a unique email address, first name and last name and assigned :ref:`role<user-roles>`. Optionally, a user can have affiliation specified.

.. figure:: invite/form.png
:width: 400
Expand All @@ -13,4 +13,4 @@ As administrators, we can create new users manually by clicking :guilabel:`Invit

.. NOTE::

If the user is invited by administrator, the user is activated by default. We can select if we want to send an invitation email or not by :guilabel:`Send invitation email` switch.
If the user is invited by admin, the user is activated by default. We can select if we want to send an invitation email or not by :guilabel:`Send invitation email` switch.
2 changes: 1 addition & 1 deletion docs/applications/analytics/knowledge-models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Knowledge Models
****************

As an administrator, we can view analytics of knowledge models. 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 admin, we can view analytics of knowledge models. 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:: knowledge-models/overview.png
:width: 700
Expand Down
2 changes: 1 addition & 1 deletion docs/applications/analytics/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Projects
********

As an administrator, we can view analytics of projects. 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 admin, we can view analytics of projects. 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:: projects/overview.png
:width: 700
Expand Down
2 changes: 1 addition & 1 deletion docs/applications/analytics/user-groups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
User Groups
***********

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.
As an admin, 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.

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

Expand Down
2 changes: 1 addition & 1 deletion 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 admin, 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
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ We can select the **Dashboard Style** whether the user should see a standard **w

* **Import KM / Document Template Widgets** allow to proceed easily to import of a knowledge model or a document template in case the |registry_name| connection is configured.

* **Administrator**
* **Admin**

* **Outdated KM / Document Templates Widgets** allow to quickly see outdated packages and document templates in case the |registry_name| connection is configured.

Expand Down
Binary file not shown.
1 change: 0 additions & 1 deletion docs/applications/data-management-planner/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Data Management Planner is an application for collaborative and effective creati
Knowledge Models<knowledge-models/index>
Document Templates<document-templates/index>
Projects<projects/index>
Documents<documents/index>
Administration<administration/index>
Profile<profile/index>

Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ Knowledge Model Preview

The preview feature for knowledge models allows us to check the content, i.e. how the questionnaire looks like. It can be used to navigate just through the top-level questions. However, with a know UUID of the question, we can create a direct link to a certain question:

For a nested question, all needed question above in the tree will be automatically prefilled. The KM preview may be also available to non-logged-in users, if configured by administrators in :doc:`../../administration/settings/content/knowledge-models`.
For a nested question, all needed question above in the tree will be automatically prefilled. The KM preview may be also available to non-logged-in users, if configured by admins in :doc:`../../administration/settings/content/knowledge-models`.

A user can directly create a new project from the KM preview. Again, this can be available also for non-logged-in users if anonymous projects are enabled by administrations in :doc:`../../administration/settings/content/projects`.
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Documents
*********

As admins, we can quickly browse all documents stored in the |project_name| by navigating to :guilabel:`Documents` from the main menu. It is possible to search for a document by name or sort them using the name or creation timestamp.
As admins, we can quickly browse all documents stored in the |project_name| instance by navigating to :guilabel:`Documents` from the projects menu. It is possible to search for a document by name or sort them using their name or creation timestamp.

Each document has a name, format, specific size (if the generation is completed), a link to the project it was generated from, and a template used for its creation. The document can be directly downloaded or deleted from the list. Additionally, we can quickly navigate to the project from which the document was created.
Each document has a name, format, specific size (if the generation is completed), a link to the project it was generated from, and a template used for its creation. The document can be directly downloaded or deleted from the list.

In case that there is a document that was not generated due to an error, we can check the error message. Also, if there are some documents got stuck in :guilabel:`Queued` or :guilabel:`In Progress` status, we should check the deployment (especially of the document worker component).

.. figure:: index/list.png
.. figure:: documents/documents.png

List of all documents across projects.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions docs/applications/data-management-planner/projects/files.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Files
*****

As admins, we can quickly browse all files stored in the |project_name| instance by navigating to :guilabel:`Files` from the projects menu. It is possible to search for a file by name or sort them using their creation timestamp, name or size.

Each file has a name, size, a link to the project it was uploaded to and user who uploaded it. The file can be directly downloaded or deleted from the list.

.. WARNING::

It is not recommended to delete files from the list without informing the project team, as it can lead to confusion among researchers. Admins should always communicate with the project team before deleting files.


.. figure:: files/files.png

List of all files across projects.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/applications/data-management-planner/projects/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,6 @@ Projects are mainly used by the researchers. We have the introduction video abou
:maxdepth: 2

List<list/index>
Files<files>
Documents<documents>
Importers<importers>
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ We can use the project as a :ref:`project template<project-templates>`. If we en
Project template options are visible only for Data Stewards or Admins.


*Unsupported metamodel* can appear, when the document template is not compatible with the version of |project_name|. Researchers should contact their Data Steward or Administrator in this case.
*Unsupported metamodel* can appear, when the document template is not compatible with the version of |project_name|. Researchers should contact their Data Steward or Admin in this case.

Knowledge Model
===============
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Create
******

As an administrator, we can create a value integration. To start, we must fill in its name and id. After clicking on :guilabel:`Create` button, we can continue in the :ref:`value integration detail<detail>`.
As an admin, we can create a value integration. To start, we must fill in its name and id. After clicking on :guilabel:`Create` button, we can continue in the :ref:`value integration detail<detail>`.

.. figure:: create/create.png
:width: 450
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Detail
******

As an administrator, we need to fill in some information about the Integration. We have filled ``name`` and ``ID`` in the previous step, now we just need to fill in the ``Response Item Template``. This defines how the items from the values will be displayed for the user. You can use the column names as item properties in ``Jinja2`` notation. You can also use ``Markdown`` for some formatting. For example, if there is a column called name, you can use ``**{{item.name}}**`` to display the name in bold.
As an admin, we need to fill in some information about the Integration. We have filled ``name`` and ``ID`` in the previous step, now we just need to fill in the ``Response Item Template``. This defines how the items from the values will be displayed for the user. You can use the column names as item properties in ``Jinja2`` notation. You can also use ``Markdown`` for some formatting. For example, if there is a column called name, you can use ``**{{item.name}}**`` to display the name in bold.

.. figure:: detail/info.png
:width: 700
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Value Integrations
******************

As an administrator, we can use value integration to setup an integration to be used by Data Stewards in their Knowledge Models as source of data.
As an admin, we can use value integration to setup an integration to be used by Data Stewards in their Knowledge Models as source of data.

We can start creating a new value integration by clicking on the :guilabel:`Create` button.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Here are some recommended sections where to start based on the role:
* - :ref:`projects`
- :ref:`knowledge-models`
- :ref:`user-list`
* - :ref:`documents`
* -
- :ref:`document-templates`
- :ref:`user-groups`
* -
Expand Down
Loading

0 comments on commit b1cbfbb

Please sign in to comment.