Skip to content

Commit 8d531c8

Browse files
Add 4.13 guide
1 parent 61f5198 commit 8d531c8

File tree

8 files changed

+23
-5
lines changed

8 files changed

+23
-5
lines changed

docs/about/introduction/knowledge-model.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ The value question asks for a single value that users type in. There are many di
8080

8181
The input field differs based on the value type (simple input for string, date picker for date, etc.). Some of these have a check whether the entered value is valid (such as valid email or URL) and displays a warning if not.
8282

83+
Value Question also can have validations. Validations differ based on the value type. For example, we can set a minimum and maximum value for a number, or a minimum and maximum length for a string. For text based types (text, email, URL), we can set also use a regular expression to create validations.
8384

8485
.. _integration-question:
8586

@@ -139,6 +140,11 @@ Choice
139140

140141
A choice is used with :ref:`multi-choice questions<multi-choice-question>`. It only contains a **label** which is presented to the user.
141142

143+
.. _validation:
144+
145+
Validation
146+
147+
Validation is used to define some rules for the answers in Value question type. It can be used to check if the answer is in the correct format, or if it is in the correct range. If the answer doesn't pass the validation, a warning is displayed to the user, however this does not prevent them from creating a document.
142148

143149
.. _reference:
144150

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ The :guilabel:`Files` tab in :doc:`./index` allows us to manage the files and di
55

66
If we select a text file in the file tree, it is opened in the built-in text editor. We can also open multiple files (the editor supports tabs). Moreover, if we have more files opened, we can see a *split view* icon on the top of the file tree. When we click it, it will split the view and move the opened file to the other group. If there are already two groups, it switches the file between the two groups. We can close the file by clicking cross icon in its tab.
77

8-
We can easily delete a file or a folder; when it is selected in the file tree, we can simply click the red trash icon above the file tree. The deletion must be confirmed in the prompt so we will not delete something by accident as it is not reversible operation.
8+
We can easily delete files; when it is selected in the file tree, we can simply click the red trash icon above the file tree. The deletion must be confirmed in the prompt so we will not delete something by accident as it is not reversible operation. To delete folder, we must first delete all files and folders in it. Then it disappears from the file tree.
9+
10+
With files and folders we can also use move and rename functionalities, both by clicking their respective icons above the file tree. The move functionality is useful when we want to move a file to another folder. The rename functionality is useful when we want to change the name of a file or folder.
911

1012
If we make some changes in a file, the asterisk (or star) symbol will appear by the name in the tree view as well as in the tab (if opened). The changes must be then saved using :guilabel:`Save` button or discarded using :guilabel:`Discard` button in the top right corner. Those buttons will appear instead of :guilabel:`Publish` as it is not possible to publish a document template with unsaved changes. After saving the changes and switching to :doc:`./preview` (or refreshing it), the document will be re-generated using the newly changed document template.
1113

docs/application/document-templates/list/detail.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ We can check a document template detail by clicking on a desired template in the
55

66
The main part of the detail is the README of the template that should contain basic information and changelog for the template. In the right panel under the basic information, we can navigate to other versions of the document template, navigate to the `DSW Registry <https://registry.ds-wizard.org>`__ (if the template is present there), or check compatible knowledge model with the template.
77

8-
In the top bar, we can :guilabel:`Export` the template as a ZIP package or :guilabel:`Delete` this version of the template (only if it is not already used for some documents). We can also quickly navigate to :doc:`../editors/create` by clicking :guilabel:`Create editor`; it will prepare editor creation for a new version of this document template. Finally, there is the possibility :guilabel:`Set deprecated` which will change the state of the document template so it is no longer usable by researchers in their projects (it becomes unavailable).
8+
In the top bar, we can :guilabel:`Export` the template as a ZIP package or :guilabel:`Delete` this version of the template (only if it is not already used for some documents). We can also quickly navigate to :doc:`../editors/create` by clicking :guilabel:`Create editor`; it will prepare editor creation for a new version of this document template. Finally, there is the possibility :guilabel:`Set deprecated` which will change the state of the document template so it is no longer usable by researchers in their projects (it becomes unavailable). This only applies to the latest version of the document template. If there is an older version, that will still be available.
99

1010
If we are not seeing the latest version of the template, a warning message is shown in the top. Similarly, we will see a notification that update is available if there is a newer version in the `DSW Registry <https://registry.ds-wizard.org>`__ (if configured).
1111

docs/application/knowledge-models/editors/detail/knowledge-model.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ There are different entities we can edit in the knowledge model, the editor show
4545
- :ref:`Question<question>`
4646
- :ref:`Answer<answer>`
4747
- :ref:`Choice<choice>`
48+
- :ref:`Validation<validation>`
4849
- :ref:`Expert<expert>`
4950
- :ref:`Metric<metric>`
5051
- :ref:`Phase<phase>`

docs/application/knowledge-models/list/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ Finally, there is an option to :doc:`./import` by click the :guilabel:`Import` b
2727

2828
List of all knowledge models with actions.
2929

30+
31+
.. NOTE::
32+
33+
Set deprecated option will apply only for the latest version of Knowledge Model. If there is an older version, that will still be available.
34+
3035
.. raw:: html
3136

3237
<h2>Table of Contents</h2>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Value Question
113113

114114
Value question contains an input field for our answer. This can be a simple text field (such as asking for a project contributor's name), or some additional widget, for example a date picker.
115115

116-
Some of the value types contains a validation (e.g., email or URL). We can still type in an invalid answer, but it will display a warning and also show it in the list of :ref:`warnings<warnings>`.
116+
All of value question types (except for color) can have validations set on them. We can still type in an invalid answer, but it will display a warning and also show it in the list of :ref:`warnings<warnings>`.
117117

118118
.. figure:: questionnaire/value-question.png
119119

@@ -200,7 +200,7 @@ If there are some project importers available for the project, there is the :gui
200200
Warnings
201201
========
202202

203-
Some value questions (such as email or URL) validates the answer written there. If it is an invalid value, we will see :guilabel:`Warnings` tab in the questionnaire menu bar with a badge showing the number of warnings. If we click on it, we can see a list of all questions that has a warning and we can click on it to navigate quickly to that question.
203+
All of value question types (except for color) can have validations set on them. If it is an invalid value, we will see :guilabel:`Warnings` tab in the questionnaire menu bar with a badge showing the number of warnings. If we click on it, we can see a list of all questions that has a warning and we can click on it to navigate quickly to that question.
204204

205205
.. figure:: questionnaire/warnings.png
206206
:width: 487

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
project_name_full = 'Data Stewardship Wizard'
2626

2727
# The full version, including alpha/beta/rc tags
28-
version = release = '4.12'
28+
version = release = '4.13'
2929

3030
rst_prolog = f"""
3131

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ Usually, nothing special is required for the upgrade. Internal structure changes
4343

4444
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.
4545

46+
4.12.X to 4.13.X
47+
----------------
48+
49+
*(nothing)*
4650

4751
4.11.X to 4.12.X
4852
----------------

0 commit comments

Comments
 (0)