Skip to content

Commit

Permalink
Preview (#89)
Browse files Browse the repository at this point in the history
* Add 4.8.0
  • Loading branch information
krystofkomanec authored Aug 9, 2024
1 parent 435ecf7 commit da844fb
Show file tree
Hide file tree
Showing 112 changed files with 60 additions and 11 deletions.
1 change: 1 addition & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@ watch:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@rm -rf ./_build
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Binary file modified docs/applications/admin-center/audit-log/index/detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/audit-log/index/list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/import/index/index.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/import/projects/projects.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/import/users/users.png
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.
Binary file modified docs/applications/admin-center/profile/edit/api-keys/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/profile/edit/index/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Using these settings we can add `Open ID <https://openid.net/>`__ configuration
* Configure the client to have the following claims: ``openid``, ``profile``, ``email``
* 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/v5/search?o=r&m=free>`_), **Name**, **Background**, and text/icon **Color**.
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::

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.
Binary file modified docs/applications/admin-center/settings/info/usage/table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To request users to agree with **Privacy Policy** and/or **Terms of Service** do
Support
=======

These settings also allow us to configure **Support Email** that users can use to request help or report issues. Similarly **Support Site Name** and **Support Site URL** can be used in case we want users to create tickets in issue tracker of some repository, e.g., on GitHub. **Support Site Icon** can also be configured, using `Font Awesome <https://fontawesome.com/v5/search>`_. These support links together with an icon are then shown in :guilabel:`Report issue` modal window.
These settings also allow us to configure **Support Email** that users can use to request help or report issues. Similarly **Support Site Name** and **Support Site URL** can be used in case we want users to create tickets in issue tracker of some repository, e.g., on GitHub. **Support Site Icon** can also be configured, using `Font Awesome <https://fontawesome.com/v6/search?o=r&m=free>`_. These support links together with an icon are then shown in :guilabel:`Report issue` modal window.

.. figure:: privacy-and-support/privacy-and-support.png
:width: 700
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Look and Feel Settings allow us to configure **Application Title** and **Short A

Colors settings.

Lastly we can easily add custom links to the main (left) menu by clicking :guilabel:`Add link` under **Custom Menu Links**. For each link, we can set **Icon** (from `Font Awesome <https://fontawesome.com/v5/search>`_), **Title** and the target **URL**. We can also set whether the link should open in **New Window** (if not, it will navigate user directly in the same window/tab from |project_name|). Once the links are there, we can manage them or delete them at this place.
Lastly we can easily add custom links to the main (left) menu by clicking :guilabel:`Add link` under **Custom Menu Links**. For each link, we can set **Icon** (from `Font Awesome <https://fontawesome.com/v6/search?o=r&m=free>`_), **Title** and the target **URL**. We can also set whether the link should open in **New Window** (if not, it will navigate user directly in the same window/tab from |project_name|). Once the links are there, we can manage them or delete them at this place.

.. figure:: look-and-feel/custom-menu-links.png

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.
Binary file modified docs/applications/admin-center/user-groups/detail/members.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/user-groups/index/list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/users/detail/profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/users/index/list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/applications/analytics/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ It is also possible to turn on regular synchronization in settings. This will sy
.. toctree::
:maxdepth: 2

Knowledge Models<knowledge-models>
Projects<projects>
Users<users>
User Groups<user-groups>
Expand Down
31 changes: 31 additions & 0 deletions docs/applications/analytics/knowledge-models.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.. _analytics-knowledge-models:

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.

.. figure:: knowledge-models/overview.png
:width: 700

Knowledge models 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:: knowledge-models/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`.
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.
Binary file modified docs/applications/analytics/projects/overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/analytics/projects/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/analytics/user-groups/detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/analytics/user-groups/overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/analytics/user-groups/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/analytics/users/detail.png
Binary file modified docs/applications/analytics/users/overview.png
Binary file modified docs/applications/analytics/users/settings.png
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This part of settings allows us to adjust how the |project_name| menu looks like
Custom Menu Links
=================

We can easily add custom links to the main (left) menu by clicking :guilabel:`Add` under **Custom Menu Links**. For each link, we can set **Icon** (from `Font Awesome <https://fontawesome.com/v5/search>`_), **Title** and the target **URL**. We can also set whether the link should open in **New Window** (if not, it will navigate user directly in the same window/tab from |project_name|). Once the links are there, we can manage them or delete them at this place.
We can easily add custom links to the main (left) menu by clicking :guilabel:`Add` under **Custom Menu Links**. For each link, we can set **Icon** (from `Font Awesome <https://fontawesome.com/v6/search?o=r&m=free>`_), **Title** and the target **URL**. We can also set whether the link should open in **New Window** (if not, it will navigate user directly in the same window/tab from |project_name|). Once the links are there, we can manage them or delete them at this place.

.. figure:: menu/custom-links.png

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For example, if we set **Organization ID** to *fw*, **Knowledge Model ID** to *r
Formats
=======

Each document template can support multiple file formats and users will be able to select which one they want to use to generate (or preview a document). We can add a new format by clicking :guilabel:`Add` button. Then, each format must have a **Name** and **Icon** (by using `Font Awesome <https://fontawesome.com/v5/search>`_).
Each document template can support multiple file formats and users will be able to select which one they want to use to generate (or preview a document). We can add a new format by clicking :guilabel:`Add` button. Then, each format must have a **Name** and **Icon** (by using `Font Awesome <https://fontawesome.com/v6/search?o=r&m=free>`_).

Each format has some steps which capture how a file for that format is produced. There are different steps defined such as ``json``, ``jinja2``, ``pandoc``, or ``wkhtmltopdf`` which is used as its **Name**. Then, the step may have certain configuration **Options**. For example, ``jinja2`` must have ``content-type``, ``extension``, and ``template`` specified. All the possible steps and their options are further described in the :ref:`Document Template Development<document-worker-steps>`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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.

Each document has name, format, and certain size (if the generation is finished). It can be directly downloaded or deleted from the list. Moreover, we can quickly navigate to the project from which the document is 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. Additionally, we can quickly navigate to the project from which the document was created.

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).

Expand Down
Binary file modified docs/applications/data-management-planner/profile/index/menu.png
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ We can share project with other |project_name| users or even external collaborat
Project sharing settings.


If we want to only see how Sharing is set up or copy the project link, we can use the arrow button which is a part of the :guilabel:`Share` button.

.. figure:: sharing/share-dropdown.png
:width: 300

Fast project sharing.


.. NOTE::

When the sharing settings is changed, the changes are saved automatically.


There are different roles in the project that can access different features:

.. raw:: html
Expand Down Expand Up @@ -140,7 +153,6 @@ We can enable the :guilabel:`Visible by other logged-in users` toggle to grant a
This can be useful, when we want to have an example project accessible by everybody. We can simply enable this and choose that other users can **view** the project. We also want to set this up when we create a :ref:`project template<project-templates>`.



Public link
===========

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ Project List

In the project list, we can see a list of all projects we have access to. Those are the projects where we were assigned to with any role or that are visible by all other logged-in users in the :ref:`project sharing settings<sharing>`. The projects are filtered to those we are explicitly assigned to by default.

We can see projects name, label :guilabel:`Template` if the project is a template, and icon indicating sharing settings:

- **Lock icon** - the project can be only accessed by you
- **People icon** - the project is shared with other users, hovering on the icon provides additional information
- **Globe icon** - anyone with a link can access the project

.. figure:: index/project-list.png

Project list with filters.
Expand All @@ -24,7 +30,6 @@ We can search for specific projects using the search field or filter them using

We can :ref:`create a new project<create-project>` by clicking the :guilabel:`Create` button.


By clicking the triple dots on each of the item in the list we can access some actions:

- **Open project** - will simply open the project
Expand All @@ -38,7 +43,6 @@ If there is an ongoing :ref:`project migration<project-migration>`, there are di
- **Continue migration** - to come back to the ongoing project migration
- **Cancel migration** - to cancel the ongoing project migration


.. raw:: html

<h2>Table of Contents</h2>
Expand Down
Binary file modified docs/applications/integration-hub/value-integrations/index/list.png
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
registry_name = 'FAIR Wizard Registry'

# The full version, including alpha/beta/rc tags
version = release = '4.7'
version = release = '4.8'

rst_prolog = f"""
Expand Down
2 changes: 1 addition & 1 deletion docs/more/development/document-templates/specification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ A template can describe how to produce several formats, each with these metadata

* ``uuid``: UUID of the format (within template)
* ``name``: display name of the format
* ``icon``: icon style (CSS classes), preferably `Font Awesome <https://fontawesome.com/v5/search>`__, e.g. ``fas fa-file-word``
* ``icon``: icon style (CSS classes), preferably `Font Awesome <https://fontawesome.com/v6/search?o=r&m=free>`__, e.g. ``fas fa-file-word``
* ``steps``: list of steps for document worker to produce the document with this format, each step has ``name`` and ``options`` (see :ref:`document-worker-steps`)


Expand Down
Binary file modified docs/more/miscellaneous/fw-registry/fw-registry.png

0 comments on commit da844fb

Please sign in to comment.