Skip to content

Commit

Permalink
Merge pull request #111 from codevence/hotfix/add-4-13-screenshots
Browse files Browse the repository at this point in the history
Hotfix/add 4 13 screenshots
  • Loading branch information
krystofkomanec authored Dec 11, 2024
2 parents 397d541 + 3110f16 commit 7cbeb09
Show file tree
Hide file tree
Showing 15 changed files with 44 additions and 35 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 24 additions & 4 deletions docs/applications/admin-center/automations/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,19 @@ Automations

Automations are customizable pieces of code that adjust the behavior of FAIR Wizard when certain events occur. Currently, automations support events when user logs in via Single Sing On (OpenID or SAML).

.. TODO::
.. figure:: automations/list.png

List of Automations with possible actions.

Add list screenshot

The Automations use the Integration SDK to create and manage automations. The SDK provides a set of classes and methods that allow you to create and manage automations. The SDK is available in the FAIR Wizard application and can be accessed by going to the Open ID or SAML Settings. The SDK has its own `documentation <https://integration-sdk.fair-wizard.com/en/latest/>`__.

From Automations list we can open specific automations or delete them. To create a new automation, go either to :doc:`../settings/authentication/openid` or :doc:`../settings/authentication/saml`.

.. TODO::
.. figure:: automations/openid-configuration.png

Example of Open ID Automation configuration.

Add Automation detail screenshot

Example of OpenID Automation to check if an user should be able to login:

Expand Down Expand Up @@ -51,3 +53,21 @@ Example of OpenID Automation to check if an user should be able to login:
email=email,
user_group_uuids=groups,
)
.. figure:: automations/openid-logs.png

Each run of an Automation is logged.


Similarly we can set up an Automation for SAML login.

.. figure:: automations/saml-configuration.png

Example of SAML Automation configuration.


.. figure:: automations/saml-logs.png

Each run of an Automation is logged.


Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,24 @@ Using these settings we can add `Open ID <https://openid.net/>`__ configuration
* Configure the client to provide the following details in ID tokens: ``email``, ``given_name``, ``family_name``

Back in the |project_name| settings, we can fill **Client ID**, **Client Secret**, and **URL** from our OpenID client together with optional **Parameters** (usually not needed). Finally, we can configure how the log-in button will look like by setting **Icon** (by using `Font Awesome <https://fontawesome.com/v6/search?o=r&m=free>`_), **Name**, **Background**, and text/icon **Color**.

.. NOTE::

After setting a new OpenID service, we should directly test it and verify that the configuration works well. For that, we can simply open our |project_name| instance in a new anonymous window of the web browser.

.. figure:: openid/openid.png
:width: 700

Example configuration of OpenID service.

.. TODO::

Update above screenshot, there is now Add automation button
.. NOTE::

We can use the **Add automation** button to add some extra steps after users use this login option. There are two tabs. Configuration, where we can set up automation using the `Integration SDK <https://integration-sdk.fair-wizard.com/en/latest/>`__ and Logs where we can see logs of the automation. The automation can have its name changed and it can be enabled or disabled.
After setting a new OpenID service, we should directly test it and verify that the configuration works well. For that, we can simply open our |project_name| instance in a new anonymous window of the web browser.

We can use the **Create automation** button to add some extra steps after users use this login option. There are two tabs. Configuration, where we can set up automation using the `Integration SDK <https://integration-sdk.fair-wizard.com/en/latest/>`__ and Logs where we can see logs of the automation. The automation can have its name changed and it can be enabled or disabled. See details in :ref:`automations`.

.. TODO::
.. figure:: openid/openid-detail.png
:width: 700

Configured OpenID service (with hidden details).

Add Automation Configuration screenshot

.. NOTE::

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 5 additions & 6 deletions docs/applications/admin-center/settings/authentication/saml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,14 @@ Based on SAML, FAIR Wizard supports authentication using `Shibboleth <https://ww

Example configuration of SAML service.

.. TODO::

Update above screenshot, there is now Add automation button
We can use the **Create automation** button to add some extra steps after users use this login option. There are two tabs. Configuration, where we can set up automation using the `Integration SDK <https://integration-sdk.fair-wizard.com/en/latest/>`__ and Logs where we can see logs of the automation. The automation can have its name changed and it can be enabled or disabled. See details in :ref:`automations`.

We can use the **Add automation** button to add some extra steps after users use this login option. There are two tabs. Configuration, where we can set up automation using the `Integration SDK <https://integration-sdk.fair-wizard.com/en/latest/>`__ and Logs where we can see logs of the automation. The automation can have its name changed and it can be enabled or disabled.

.. TODO::
.. figure:: saml/saml-detail.png
:width: 700

Configured SAML service (with hidden details).

Add Automation Configuration screenshot

.. NOTE::

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 7 additions & 10 deletions docs/applications/admin-center/settings/system/ai-assistant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,17 @@ AI Assistant is FAIR Wizard wide feature that allows you to interact with the AI

The AI Assistant is available in the bottom left corner of the screen. The AI Assistant will appear on the right side, where you can interact with it.

The AI Assistant does not have access to any FAIR Wizard data. Its knowledge is based on the information available in this FAIR Wizard documentation. The AI Assistant is designed to help you navigate FAIR Wizard and provide you with the information you need to complete your tasks.

The AI Assistant can be turned off in the settings.
.. figure:: ai-assistant/ai-assistant.png
AI Assistant.

.. TODO::

Add screenshots
The AI Assistant does not have access to any FAIR Wizard data. Its knowledge is based on the information available in this FAIR Wizard documentation. The AI Assistant is designed to help you navigate FAIR Wizard and provide you with the information you need to complete your tasks.

.. .. figure:: ai-assistant/ai-assistant.png
:width: 700
AI Assistant.
The AI Assistant can be turned off in the settings.

.. .. figure:: ai-assistant/ai-assistant-settings.png
.. figure:: ai-assistant/settings.png
:width: 700

AI Assistant settings.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 0 additions & 6 deletions docs/more/development/document-templates/steps/pandoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,6 @@ Options
- (optional, experimental) ``filters`` = additional `Pandoc filters <https://pandoc.org/MANUAL.html#general-options>`__ to be used, need to be located under ``/pandoc/filters`` directory (or other set by ``PANDOC_FILTERS`` environment variable), comma separated
- (optional, experimental) ``template`` = `Pandoc template <https://pandoc.org/MANUAL.html#general-options>`__ to be used, need to be located under ``/pandoc/templates`` directory (or other set by ``PANDOC_TEMPLATES`` environment variable)

Notes
=====

- Pandoc filter ``pandoc-docx-pagebreakpy`` can be found in `addons <../../addons>`__ directory.
- Pandoc filter ``pandoc-docx-pagebreakpy`` will be removed with the next template metamodel version, use `` for the ``filters`` option instead.

Example
=======

Expand Down

0 comments on commit 7cbeb09

Please sign in to comment.