Commit 852a08aa authored by Richard Glosner's avatar Richard Glosner Committed by Martin Horák
Browse files

* fix: correct link updater 

* style: align download buttons in the table

* docs: add direct link from main page to definitions table

* docs: add more definition zips for Dux

* style: formatted content with formatting script

* docs: add page with list of available definitions
parent e7a73f3b

backend @ 670d63db

Compare e3879174 to 670d63db
Original line number Diff line number Diff line 
Subproject commit e3879174c07ab4a24cd3b09fdd7260a85e90d668
 
Subproject commit 670d63db34d4472280332b5468ba9aac62c8a12b

docs/INJECT_process/available-definitions.md

0 → 100644
+22 −0
Original line number Diff line number Diff line 
<style>

.md-typeset .md-button {

    margin: 0;

}

</style>



# Available Exercise Definitions



The INJECT team has prepared an example content that is available to you for the ease of adoption of IXP.



---



| Definition Name            | Needs Instructor | Language | Download                                                                                                                                                     |

| -------------------------- | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |

| Introductory Definition    | NO               | English  | [Download](https://gitlab.fi.muni.cz/inject/inject-docs/-/raw/dux/files-from-repos/intro-definition.zip?ref_type=heads&inline=false){ .md-button }           |

| Showcase Definition        | YES              | English  | [Download](https://gitlab.fi.muni.cz/inject/inject-docs/-/raw/dux/files-from-repos/showcase-definition.zip?ref_type=heads&inline=false){ .md-button }        |

| Phishing Uni               | YES              | English  | [Download](https://gitlab.fi.muni.cz/inject/inject-docs/-/raw/dux/files-from-repos/phishing-uni.zip?ref_type=heads&inline=false){ .md-button }               |

| Phone Loss                 | Non-essential    | English  | [Download](https://gitlab.fi.muni.cz/inject/inject-docs/-/raw/dux/files-from-repos/phone-loss.zip?ref_type=heads&inline=false){ .md-button }                 |

| Insider Threat             | NO               | English  | [Download](https://gitlab.fi.muni.cz/inject/inject-docs/-/raw/dux/files-from-repos/insider-threat.zip?ref_type=heads&inline=false){ .md-button }             |

| Security Training Call     | NO               | Czech    | [Download](https://gitlab.fi.muni.cz/inject/inject-docs/-/raw/dux/files-from-repos/security-training-call.zip?ref_type=heads&inline=false){ .md-button }     |

| Security Training Notebook | NO               | Czech    | [Download](https://gitlab.fi.muni.cz/inject/inject-docs/-/raw/dux/files-from-repos/security-training-notebook.zip?ref_type=heads&inline=false){ .md-button } |

| Security Training Phishing | NO               | Czech    | [Download](https://gitlab.fi.muni.cz/inject/inject-docs/-/raw/dux/files-from-repos/security-training-phishing.zip?ref_type=heads&inline=false){ .md-button } |

docs/index.md

+3 −0
Original line number Diff line number Diff line
@@ -31,6 +31,9 @@ this documentation will equip you with the tools and knowledge needed for succes 
  [Exercise Preparation](INJECT_process/intro/overview.md){ .md-button }

</div>

<div class="navigation-main" markdown>

  [Platform Content](INJECT_process/available-definitions.md){ .md-button }

</div>

<div class="navigation-main" markdown style="grid-column-start: 2;">

  [Report issues](report-issue.md){ .md-button }

</div>

</div>

docs/tech/architecture/definitions/CHANGELOG.md

+50 −49
Original line number Diff line number Diff line
@@ -2,10 +2,8 @@ 


## You might find useful



- If you are looking for the platform changelog, go here:

    [platform changelog](../../../changelog.md).

- If you are interested in the definition and platform compatibility, go here:

    [version compatibility](../../version-compatibility.md).

- If you are looking for the platform changelog, go here: [platform changelog](../../../changelog.md).

- If you are interested in the definition and platform compatibility, go here: [version compatibility](../../version-compatibility.md).



---
@@ -19,8 +17,9 @@ Remove `correct` field length requirement from `multiple-choice` questions 


## 0.23.2



Add option to make a questionnaire repeatable. Removed requirement to have at least one of

`correct`/`incorrect` fields specified in `auto-free-form` questions.

Add option to make a questionnaire repeatable.

Removed requirement to have at least one of `correct`/`incorrect` fields specified in

`auto-free-form` questions.



### questionnaires.yml
@@ -64,8 +63,9 @@ Add an optional field to questionnaires to allow submitting answers after the ex 


## 0.22.2



Add an optional internal drive feature. Files in the drive will be visible to everyone in the

exercise. To add a drive, simply create a `drive` directory with files in the definition.

Add an optional internal drive feature.

Files in the drive will be visible to everyone in the exercise.

To add a drive, simply create a `drive` directory with files in the definition.



## 0.22.1
@@ -77,7 +77,8 @@ Add an option to specify that an email address is digitally signed. 


## 0.22.0



Add a field for instructor notes. Make overlay duration optional

Add a field for instructor notes.

Make overlay duration optional



### common definitions
@@ -183,8 +184,8 @@ Add note to questions. 


## 0.18.0



Add option to tools to signify that they don't require an input. Change the type of

`default_response` field.

Add option to tools to signify that they don't require an input.

Change the type of `default_response` field.



### tools.yml
@@ -201,12 +202,13 @@ No format changes 


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.

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. Add missing field from tools.

Add support for markdown in questionnaires.

Add missing field from tools.



### questionnaires.yml
@@ -303,12 +305,14 @@ Allow multiple info channels in a definition. 


## 0.13.0



Enabled a more fine-grained control over milestone modifications for scale-based questions.

Enabled a more fine-grained control over milestone modifications for

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

- added field `controls` in question objects,

    which is a mapping of `choice number` to `control`.

    See definition documentation for more details.



## 0.12.1
@@ -321,8 +325,8 @@ 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`.

Replace `text` field by `content` in `Questionnaire` questions.

From now, the questions of questionnaires can be formatted via `content`.



### questionnaires.yml
@@ -331,9 +335,9 @@ questionnaires can be formatted via `content`. 


## 0.11.0



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.

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.



### injects.yml
@@ -341,8 +345,8 @@ alternative can be selected. 


## 0.10.0



Change the behavior of `info` alternatives. When an alternative contains no `content`, it will not

create an action log.

Change the behavior of `info` alternatives.

When an alternative contains no `content`, it will not create an action log.



### injects.yml
@@ -358,7 +362,8 @@ Add option to specify initial state for milestones. 


## 0.9.0



Removed manual injects. All injects are now considered to be **automatic injects**.

Removed manual injects.

All injects are now considered to be **automatic injects**.



### injects.yml
@@ -366,8 +371,8 @@ Removed manual injects. 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.

Add a new required concept called `learning objectives`.

This concept _must_ be included in all exercise definition.



### objectives.yml
@@ -399,14 +404,13 @@ Add overlay to injects. 


## 0.6.0



Added a new concept called `channels`. This concept is saved in a new `channels.yml` file. See

definition documentation 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



- remove `enable_email` field

- remove `team_visible_milestones` field, team visible milestones can now be specified without this

    flag

- remove `team_visible_milestones` field, team visible milestones can now be specified without this flag



### channels.yml
@@ -431,8 +435,8 @@ definition documentation for details. 
- add `control` field to email address

- 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 definition documentation for

    details.

- add new fields `content` and `control` to email templates,

    see definition documentation for details.



## 0.5.1
@@ -449,8 +453,8 @@ Allow using directories of files instead of single YAML files inside the definit 
### config.yml



- remove `team_file_upload` field, the feature is now always enabled

- remove `custom_team_names` field, team names have been removed from the definition, it is now a

    parameter when creating an exercise

- remove `custom_team_names` field, team names have been removed from the definition, it is now

    a parameter when creating an exercise

- remove `team_count` field, it is now a parameter when creating an exercise



### teams.yml
@@ -459,27 +463,24 @@ 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`.

Introduce simplified syntax for `activate_milestone` and `deactivate_milestone`,

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, which could be separated by a

comma, space, or comma followed by space.

Instead of the old syntax from `reach_milestone` reminding logical condition,

the new fields `(de)activate_milestone` have a simple enumeration of milestones,

which could be separated by a comma, space, or comma followed by space.



### injects.yml



- inject field `reach_milestone` is replaced by fields `activate_milestone` and

    `deactivate_milestone`

- inject field `reach_milestone` is replaced by fields `activate_milestone` and `deactivate_milestone`



### tools.yml



- response field `reach_milestone` is replaced by fields `activate_milestone` and

    `deactivate_milestone`

- response field `reach_milestone` is replaced by fields `activate_milestone` and `deactivate_milestone`



### email.yml



- email and template field `reach_milestone` is replaced by fields `activate_milestone` and

    `deactivate_milestone`

- email and template field `reach_milestone` is replaced by fields `activate_milestone` and `deactivate_milestone`



## 0.3.0
@@ -491,10 +492,10 @@ comma, space, or comma followed by space. 


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. Only one of the `content`,

`content_path` fields can be set at the same time. If neither field is set, then the content is

considered to be empty.

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.

Only one of the `content`, `content_path` fields can be set at the same time.

If neither field is set, then the content is considered to be empty.



### tools.yml

docs/tech/architecture/definitions/README.md

+221 −238

File changed.

Preview size limit exceeded, changes collapsed.