From 129e471dddf3e90bc1c2201e9b858d88b4c32efd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Juh=C3=A1s?= <xjuhas@fi.muni.cz> Date: Mon, 17 Feb 2025 14:41:37 +0100 Subject: [PATCH] * remove links to readme from changelog * remove issue numbers from changelog --- .../architecture/definitions/CHANGELOG.md | 64 +++++++++---------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/tech/architecture/definitions/CHANGELOG.md b/docs/tech/architecture/definitions/CHANGELOG.md index f5150bb..b0e91d0 100644 --- a/docs/tech/architecture/definitions/CHANGELOG.md +++ b/docs/tech/architecture/definitions/CHANGELOG.md @@ -1,6 +1,6 @@ ## 0.18.1 -Add note to questions. inject/backend#373 +Add note to questions. ### questionnaires.yml @@ -9,8 +9,8 @@ Add note to questions. inject/backend#373 ## 0.18.0 -Add option to tools to signify that they don't require an input. inject/backend#194 -Change the type of `default_response` field. inject/backend#368 +Add option to tools to signify that they don't require an input. +Change the type of `default_response` field. ### tools.yml @@ -27,15 +27,15 @@ No format changes ## 0.17.1 -Allow embedding images and videos. inject/backend#359 +Allow embedding images and videos. All `content` type fields now allow for embedding images/audio/video by using special syntax. See readme for more information. ## 0.17.0 -Add support for markdown in questionnaires. inject/backend#361 -Add missing field from tools. inject/backend#297 +Add support for markdown in questionnaires. +Add missing field from tools. ### questionnaires.yml @@ -49,7 +49,7 @@ Add missing field from tools. inject/backend#297 ## 0.16.0 -More definition enhancements. inject/backend#357 +More definition enhancements. ### config.yml @@ -71,7 +71,7 @@ More definition enhancements. inject/backend#357 ## 0.15.2 -Allow exercise designers to add more information to the definition. inject/backend#353 +Allow exercise designers to add more information to the definition. ### config.yml @@ -103,7 +103,7 @@ Allow exercise designers to add more information to the definition. inject/backe ## 0.15.1 -Add confirmation button to info alternatives. inject/backend#351 +Add confirmation button to info alternatives. ### injects.yml @@ -111,7 +111,7 @@ Add confirmation button to info alternatives. inject/backend#351 ## 0.15.0 -Allow specifying open-ended questions in questionnaires. inject/backend#340 +Allow specifying open-ended questions in questionnaires. ### questionnaires.yml @@ -121,7 +121,7 @@ Allow specifying open-ended questions in questionnaires. inject/backend#340 ## 0.14.0 -Allow multiple info channels in a definition. #336 +Allow multiple info channels in a definition. ### injects.yml @@ -133,14 +133,14 @@ Allow multiple info channels in a definition. #336 ## 0.13.0 Enabled a more fine-grained control over milestone modifications for -scale-based questions. #315 +scale-based questions. ### questionnaires.yml - remove field `control` in question objects - added field `controls` in question objects, which is a mapping of `choice number` to `control`. - See [readme](README.md#questionnairesyml) for more details. + See definition documentation for more details. ## 0.12.1 @@ -153,7 +153,7 @@ Enable specification of `roles` in `email` type injects. ## 0.12.0 Replace `text` field by `content` in `Questionnaire` questions. -From now, the questions of questionnaires can be formatted via `content`. #251 +From now, the questions of questionnaires can be formatted via `content`. ### questionnaires.yml @@ -164,7 +164,7 @@ From now, the questions of questionnaires can be formatted via `content`. #251 Change the behavior of `delay` on injects. Whenever an alternative is delayed, the condition is now checked throughout the duration. -If the condition becomes false, the inject is cancelled and a new alternative can be selected. #266 +If the condition becomes false, the inject is cancelled and a new alternative can be selected. ### injects.yml @@ -173,7 +173,7 @@ If the condition becomes false, the inject is cancelled and a new alternative ca ## 0.10.0 Change the behavior of `info` alternatives. -When an alternative contains no `content`, it will not create an action log. #264 +When an alternative contains no `content`, it will not create an action log. ### injects.yml @@ -181,7 +181,7 @@ When an alternative contains no `content`, it will not create an action log. #26 ## 0.9.1 -Add option to specify initial state for milestones. #263 +Add option to specify initial state for milestones. ### milestones.yml @@ -190,7 +190,7 @@ Add option to specify initial state for milestones. #263 ## 0.9.0 -Removed manual injects. #228 +Removed manual injects. All injects are now considered to be **automatic injects**. ### injects.yml @@ -201,7 +201,7 @@ All injects are now considered to be **automatic injects**. ## 0.8.0 Add a new required concept called `learning objectives`. -This concept _must_ be included in all exercise definition. #170 +This concept _must_ be included in all exercise definition. ### objectives.yml @@ -213,7 +213,7 @@ This concept _must_ be included in all exercise definition. #170 ## 0.7.0 -Add simple questionnaires. #165 +Add simple questionnaires. ### channels.yml @@ -226,7 +226,7 @@ Add simple questionnaires. #165 ## 0.6.1 -Add overlay to injects. #153 +Add overlay to injects. ### injects.yml @@ -235,8 +235,8 @@ Add overlay to injects. #153 ## 0.6.0 -Added a new concept called `channels` #151. This concept is saved in a new `channels.yml` file. -See [readme](README.md#channelsyml) for details. +Added a new concept called `channels`. This concept is saved in a new `channels.yml` file. +See definition documentation for details. ### config.yml @@ -252,13 +252,13 @@ See [readme](README.md#channelsyml) for details. - remove field `hidden` - rename field `injects` to `alternatives` - add field `type` to inject -- specify new types of alternatives, see [readme](README.md#alternatives-_info_) +- specify new types of alternatives, see definition documentation for details ### tools.yml - remove old `content`, `content_path`, `file_name` fields - remove old `milestone_condition`, `activate_milestone`, `deactivate_milestone`, `roles` fields -- add new fields `content` and `control`, see [readme](README.md#common-definitions) for details +- add new fields `content` and `control`, see definition documentation for details ### email.yml @@ -267,12 +267,12 @@ See [readme](README.md#channelsyml) for details. - remove old `content`, `content_path`, `file_name` templates from email templates - remove `activate_milestone`, `deactivate_milestone` fields from templates - add new fields `content` and `control` to email templates, - see [readme](README.md#common-definitions) for details + see definition documentation for details ## 0.5.1 -Allow using directories of files instead of single YAML files inside the definition #128 +Allow using directories of files instead of single YAML files inside the definition. ## 0.5.0 @@ -296,7 +296,7 @@ Allow using directories of files instead of single YAML files inside the definit ## 0.4.0 Introduce simplified syntax for `activate_milestone` and `deactivate_milestone`, -which replaced the old field `reach_milestone`. #98 +which replaced the old field `reach_milestone`. Instead of the old syntax from `reach_milestone` reminding logical condition, the new fields `(de)activate_milestone` have a simple enumeration of milestones, @@ -318,11 +318,11 @@ which could be separated by a comma, space, or comma followed by space. ### milestones.yml -- add field `final` to milestones #74 +- add field `final` to milestones ## 0.2.0 -Introduce support for markdown content in `injects`, `tool responses` and `email templates`. #84 +Introduce support for markdown content in `injects`, `tool responses` and `email templates`. Add new optional folder `content` to the definition file structure. This folder should contain markdown files which will be pointed to by `content_path` fields. @@ -346,11 +346,11 @@ If neither field is set, then the content is considered to be empty. ### email.yml -- Add `organization` field to email addresses #83 +- Add `organization` field to email addresses ### injects.yml -- Add `organization` field to inject categories #83 +- Add `organization` field to inject categories ## 0.1.0 -- GitLab