Skip to content

Commit

Permalink
Merge pull request #172 from ds-wizard/release/4.12
Browse files Browse the repository at this point in the history
Release/4.12
krystofkomanec authored Nov 7, 2024
2 parents fa51f71 + faaa944 commit 61f5198
Showing 78 changed files with 2,871 additions and 2,250 deletions.
9 changes: 9 additions & 0 deletions docs/about/introduction/knowledge-model.rst
Original file line number Diff line number Diff line change
@@ -108,6 +108,15 @@ Item Select Question

The item selection question works in conjunction with the :ref:`list of items question<list-of-items-question>`. It is used to select one of the previously created items within a series of interconnected list of items question.


.. _file-question:

File Question
^^^^^^^^^^^^^

The file question is used to upload files. We can configure the **file types** that are allowed to be uploaded and the **maximum file size**.


.. _answer:

Answer
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/application/administration/locales/detail/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/application/administration/locales/import/file.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/application/administration/locales/import/registry.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/application/administration/locales/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/application/administration/settings/info/usage/usage.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.
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/application/administration/users/detail/password.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/application/administration/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/application/administration/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.
Binary file modified docs/application/document-templates/editors/detail/files/files.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/application/document-templates/editors/detail/index/editor.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.
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/application/document-templates/editors/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/application/document-templates/list/detail/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/application/document-templates/list/import/file.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/application/document-templates/list/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/application/documents/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.
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.
Binary file modified docs/application/knowledge-models/list/detail/detail.png
Binary file modified docs/application/knowledge-models/list/import/file.png
Binary file modified docs/application/knowledge-models/list/import/registry.png
Binary file modified docs/application/knowledge-models/list/index/list.png
Binary file modified docs/application/profile/about/modal.png
Binary file modified docs/application/profile/assigned-comments/list.png
Binary file modified docs/application/profile/edit/active-sessions/form.png
Binary file modified docs/application/profile/edit/api-keys/form.png
Binary file modified docs/application/profile/edit/index/form.png
Binary file modified docs/application/profile/edit/password/form.png
Binary file modified docs/application/profile/index/menu.png
Binary file modified docs/application/projects/importers/importers.png
Binary file modified docs/application/projects/list/create/project-create.png
Binary file modified docs/application/projects/list/detail/documents/list.png
Binary file modified docs/application/projects/list/detail/documents/new.png
Binary file modified docs/application/projects/list/detail/index/questionnaire.png
Binary file modified docs/application/projects/list/detail/metrics/metrics.png
Binary file modified docs/application/projects/list/detail/preview/download.png
Binary file modified docs/application/projects/list/detail/preview/preview-html.png
14 changes: 14 additions & 0 deletions docs/application/projects/list/detail/questionnaire.rst
Original file line number Diff line number Diff line change
@@ -156,6 +156,20 @@ The item selection question is used together with the list of items question. Wh
.. Item select question with a list of items as possible answers.
File Question
-------------

File question is used when we need to upload a file as an answer. We can simply click on the :guilabel:`Upload File` button and select the file from our computer. We can also drag and drop the file into the input field.

.. TODO::

Add a screenshot of the file question.

.. .. figure:: questionnaire/file-question.png
.. File select question with a list of items as possible answers.
View settings
=============

Binary file modified docs/application/projects/list/detail/questionnaire/comments.png
Binary file modified docs/application/projects/list/detail/questionnaire/todos.png
Binary file modified docs/application/projects/list/detail/questionnaire/warnings.png
Binary file modified docs/application/projects/list/detail/settings/settings.png
Binary file modified docs/application/projects/list/detail/sharing/share-modal.png
Binary file modified docs/application/projects/list/index/project-list.png
Binary file modified docs/application/projects/list/migration/create.png
Binary file modified docs/application/projects/list/migration/migration.png
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
@@ -25,7 +25,7 @@
project_name_full = 'Data Stewardship Wizard'

# The full version, including alpha/beta/rc tags
version = release = '4.11'
version = release = '4.12'

rst_prolog = f"""
38 changes: 38 additions & 0 deletions docs/more/development/document-templates/document-context.rst
Original file line number Diff line number Diff line change
@@ -176,6 +176,19 @@ Questionnaire
- ``updated_at`` (``datetime``)


.. _odc-questionnaire-file:

QuestionnaireFile
~~~~~~~~~~~~~~~~~~~~

- ``uuid`` (``str``)
- ``name`` (``str``)
- ``size`` (``int``)
- ``content_type`` (``str``)
- ``reply`` (``Optional[``\ :ref:`odc-file-reply`\ ``]``)
- ``download_url`` (``str``)


.. _odc-questionnaire-version:

QuestionnaireVersion
@@ -469,6 +482,14 @@ ItemSelectQuestion

- ``list_question`` (``Optional[``\ :ref:`odc-list-question`\ ``]``)

.. _odc-file-question:

FileQuestion
''''''''''''

- ``max_size`` (``Optional[int]``) - maximum file size (in bytes) allowed
- ``file_types`` (``Optional[str]``) - comma-separated file type specifications


.. _odc-answer:

@@ -711,6 +732,23 @@ Notes:
- ``question`` is always :ref:`odc-value-question`


.. _odc-file-reply:

FileReply
^^^^^^^^^^^

- ``file_uuid`` (``str``)
- ``file`` (``Optional[``\ :ref:`odc-questionnaire-file`\ ``]``) - ``None`` if file has been deleted

Aliases:

- ``value`` (``str``) - same as ``file_uuid``

Notes:

- ``question`` is always :ref:`odc-file-question`


ItemListReply
^^^^^^^^^^^^^

4,572 changes: 2,495 additions & 2,077 deletions docs/more/development/document-templates/document-context.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
454 changes: 286 additions & 168 deletions docs/more/development/document-templates/document-context.uxf

Large diffs are not rendered by default.

7 changes: 6 additions & 1 deletion docs/more/development/document-templates/specification.rst
Original file line number Diff line number Diff line change
@@ -93,10 +93,15 @@ Document Template Metamodel Versions

Here are described the changes in metamodel for template specification as well as :doc:`document context<document-context>` so developers can easily update their templates to a newer metamodel version when needed. It is also possible to check JSON schemas in higher detail, see :doc:`../metamodel-schemas`.

Version 15 (since 4.12.0)
-------------------------

* Added file question, questionnaire file, and file reply.

Version 14 (since 4.10.0)
-------------------------

* Rearranged and enriched document context for clarity and completeness. If you are using the :ref:`object-oriented document context <document-context-obj>` (via ``to_context_obj``), the changes will not affect you and you can start using new attributes/types); otherwise, you need to reflect the following changes in the passed document context ``ctx``:
* Rearranged and enriched document context for clarity and completeness. If you are using the :ref:`object-oriented document context <document-context-obj>` (via ``to_context_obj``), the changes will not affect you and you can start using new attributes/types; otherwise, you need to reflect the following changes in the passed document context ``ctx``:

* ``config``, ``knowledgeModel``, ``package``, and ``report`` of context stay the same;
* ``uuid``, ``createdAt``, and ``updatedAt`` are moved to new ``document`` object that contains additional fields, namely ``createdBy``, ``documentTemplateId``, ``formatUuid``, and ``name``;
10 changes: 8 additions & 2 deletions docs/more/development/metamodel-schemas.rst
Original file line number Diff line number Diff line change
@@ -14,6 +14,8 @@ File for import and export of Knowledge Models is a JSON file that contains all
+-------------------+---------------------------------------------------------------------------------------------------------------+------------------------------------------------------+-----------+
| Metamodel Version | Schema file | Changes (brief) | Since |
+===================+===============================================================================================================+======================================================+===========+
| 16 | `JSON Schema <https://github.com/ds-wizard/dsw-schemas/blob/master/schemas/km-package/kmp_schema_v16.json>`__ | File question | 4.12.0 |
+-------------------+---------------------------------------------------------------------------------------------------------------+------------------------------------------------------+-----------+
| 15 | `JSON Schema <https://github.com/ds-wizard/dsw-schemas/blob/master/schemas/km-package/kmp_schema_v15.json>`__ | Item select question, resource collections and pages | 4.10.0 |
+-------------------+---------------------------------------------------------------------------------------------------------------+------------------------------------------------------+-----------+
| 14 | `JSON Schema <https://github.com/ds-wizard/dsw-schemas/blob/master/schemas/km-package/kmp_schema_v14.json>`__ | Optional Integration fields | 4.1.0 |
@@ -53,7 +55,9 @@ Document Context is provided to the document templates by document worker. It co
+-------------------+------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+-----------+
| Metamodel Version | Schema file | Changes (brief) | Since |
+===================+========================================================================================================================+===================================================+===========+
| 14 | `JSON Schema <https://github.com/ds-wizard/dsw-schemas/blob/master/schemas/doc-context/doc_context_schema_v14.json>`__ | new KM entities, project details, and restructure | 4.10.0 |
| 15 | `JSON Schema <https://github.com/ds-wizard/dsw-schemas/blob/master/schemas/doc-context/doc_context_schema_v15.json>`__ | File question | 4.12.0 |
+-------------------+------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+-----------+
| 14 | `JSON Schema <https://github.com/ds-wizard/dsw-schemas/blob/master/schemas/doc-context/doc_context_schema_v14.json>`__ | New KM entities, project details, and restructure | 4.10.0 |
+-------------------+------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+-----------+
| 13 | `JSON Schema <https://github.com/ds-wizard/dsw-schemas/blob/master/schemas/doc-context/doc_context_schema_v13.json>`__ | Removed states from templates | 4.3.0 |
+-------------------+------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+-----------+
@@ -94,7 +98,9 @@ Each template has its descriptor file ``template.json`` which contains all the i
+-------------------+----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+-----------+
| Metamodel Version | Schema file | Changes (brief) | Since |
+===================+============================================================================================================================+===================================================+===========+
| 14 | `JSON Schema <https://github.com/ds-wizard/dsw-schemas/blob/master/schemas/template-json/template_json_schema_v14.json>`__ | new KM entities, project details, and restructure | 4.10.0 |
| 15 | `JSON Schema <https://github.com/ds-wizard/dsw-schemas/blob/master/schemas/template-json/template_json_schema_v15.json>`__ | File question | 4.12.0 |
+-------------------+----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+-----------+
| 14 | `JSON Schema <https://github.com/ds-wizard/dsw-schemas/blob/master/schemas/template-json/template_json_schema_v14.json>`__ | New KM entities, project details, and restructure | 4.10.0 |
+-------------------+----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+-----------+
| 13 | `JSON Schema <https://github.com/ds-wizard/dsw-schemas/blob/master/schemas/template-json/template_json_schema_v13.json>`__ | Removed states from templates | 4.3.0 |
+-------------------+----------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+-----------+
Binary file modified docs/more/miscellaneous/dsw-registry/dsw-registry.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/more/self-hosted-dsw/configuration.rst
Original file line number Diff line number Diff line change
@@ -116,6 +116,13 @@ Information for connection to S3 storage (used for document and document templat
S3 service must be publicly accessible (so users can download documents and export templates or locales). Also, bucket must be created otherwise documents cannot be created and document templates / locales imported.


.. NOTE::

If you have a problem with downloading documents while running the bucket locally, try to add the following line to the /etc/hosts file:

``127.0.0.1 host.docker.internal``


Mail
^^^^

2 changes: 1 addition & 1 deletion docs/more/self-hosted-dsw/index.rst
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@ This section explains how to deploy, configure, and maintain |project_name| inst

.. NOTE::

Before going for self-hosted options, it is a good idea to try out |project_name| using `existing providers <https://ds-wizard.org/#providers>`_.
Before going for self-hosted options, it is a good idea to try out |project_name| using `existing providers <https://ds-wizard.org/get-started#providers>`_.


.. raw:: html
6 changes: 6 additions & 0 deletions docs/more/self-hosted-dsw/upgrade-guidelines.rst
Original file line number Diff line number Diff line change
@@ -43,6 +43,12 @@ Usually, nothing special is required for the upgrade. Internal structure changes

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.11.X to 4.12.X
----------------

- Document template metamodel version is raised (from 14 to 15) as File Question has been added (no breaking changes), for details check :ref:`document-template-metamodel-versions`.

4.10.X to 4.11.X
----------------

0 comments on commit 61f5198

Please sign in to comment.