Merge pull request #151 from ds-wizard/release/4.8.0

Release 4.8.0 (develop)

docs/application/administration/settings/system/authentication.rst

@@ -35,7 +35,7 @@ Using these settings we can add **OpenID Services** to allow logging into the |p
 *  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>`_), **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::
 

docs/application/administration/settings/user-interface/look-and-feel.rst

@@ -13,7 +13,7 @@ There are two titles that we can set. First, **Application Title** is the full t
 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| instance). 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| instance). Once the links are there, we can manage them or delete them at this place.
 
 
 .. figure:: look-and-feel/custom-links.png

docs/application/document-templates/editors/detail/index.rst

@@ -3,7 +3,7 @@ Document Template Editor
 
 A document template editor allows us to edit both configuration and all files of a document template. We can manage the configuration (such as template metadata, formats, and steps) on the :doc:`./settings` tab. The files including directories can be managed (created, edited, deleted, or uploaded) on the :doc:`./files` tab. Finally, the :doc:`./preview` tab allows us to quickly check how the document template works for a certain project and format and how the resulting document looks like.
 
-There is also option to :doc:`./publish` the document template via :guilabel:`Publish` bottom in the top right corner.
+There is also option to :doc:`./publish` the document template via :guilabel:`Publish` button in the top right corner.
 
 
 .. figure:: index/editor.png

docs/application/document-templates/editors/detail/settings.rst

@@ -33,7 +33,7 @@ For example, if we set **Organization ID** to *dsw*, **Knowledge Model ID** to *
 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>`.
 

docs/application/documents/index.rst

@@ -3,7 +3,7 @@ Documents
 
 As admins, we can quickly browse all documents stored in the |project_name| instance 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).
 

docs/application/projects/list/detail/sharing.rst

@@ -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 how we can share the project that can access different project features:
 
 
@@ -143,7 +156,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
 ===========
 

docs/application/projects/list/index.rst

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

docs/conf.py

@@ -25,7 +25,7 @@
 project_name_full = 'Data Stewardship Wizard'
 
 # The full version, including alpha/beta/rc tags
-version = release = '4.7'
+version = release = '4.8'
 
 rst_prolog = f"""
 

docs/more/development/document-templates/specification.rst

@@ -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`)
 
 

docs/more/self-hosted-dsw/upgrade-guidelines.rst

@@ -42,6 +42,11 @@ Usually, nothing special is required for the upgrade. Internal structure changes
 .. Warning::
 
    Make sure to stop ``document-worker`` and ``mailer`` before upgrading to the next version. Run ``wizard-server`` first, then run the workers. Otherwise the database migrations might not work correctly.
+
+4.7.X to 4.8.X
+----------------
+
+*(nothing)*
 
 4.6.X to 4.7.X
 ----------------