| ... | ... | @@ -2,7 +2,7 @@ |
|
|
|
- [Introduction](#introduction)
|
|
|
|
- [Data file Directory Structure](#data-file-directory-structure)
|
|
|
|
- [Change Management Workflow](#change-management-workflow)
|
|
|
|
- [WORK-ROLE and SPECIALIZATIONS JSON files](#work-roles-and-specializations-json-files)
|
|
|
|
- [Roadmap JSON file](#roadmap-json-file)
|
|
|
|
- [Rel-Links JSON files](#rel-links-json-files)
|
|
|
|
- [Pipeline Overview](#pipeline-overview)
|
|
|
|
|
| ... | ... | @@ -80,44 +80,13 @@ graph TD; |
|
|
|
APPROVED-- Rejected -->DEAD[CLOSED WITHOUT MERGE]
|
|
|
|
```
|
|
|
|
|
|
|
|
## WORK-ROLES and SPECIALIZATIONS JSON Files
|
|
|
|
## Roadmap JSON File
|
|
|
|
|
|
|
|
This section will describe the WORK-ROLES.json and SPECIALIZATIONS.json files. These files currently house information about the evaluation and/or training repository URLs. The URLs will be used to populate the 'training' and 'eval' rel-link information during the 'insert-rel-link-artifacts.py' script. Mandatory field information below.
|
|
|
|
|
|
|
|
Field Information
|
|
|
|
- "WR_SPEC_ID": unique identifier of the work-role/specialization (kabob case)
|
|
|
|
- "trn-rel-link-urls": urls for training repositories
|
|
|
|
- "evl-rel-link-urls": urls for eval repositories
|
|
|
|
- "follow-ons": list of WR_SPEC_IDs that can happen next
|
|
|
|
- "courses": a list of course names and links to those courses that must be completed to obtain this work role
|
|
|
|
- "lessons": a list of lessons in this course along with a link to the lesson
|
|
|
|
This section will describe the [Roadmap.json](https://gitlab.com/90cos/mttl/-/blob/master/Roadmap.json) file. This file currently house information about the work role progression within the squadron which is used to generate the [Training Roadmap](https://90cos.gitlab.io/mttl/#/roadmap)
|
|
|
|
|
|
|
|
## Rel-Links JSON Files
|
|
|
|
|
|
|
|
This section describes the *.rel-link.json file; rel is short for relation. There will be many of these files inside the 'rel-links' folder that will describe what KSAT and proficiency actual training/evaluation material adheres to. These file will be used in the pipeline to create metrics and visualization for the MTTL.
|
|
|
|
|
|
|
|
Eval required Field Information
|
|
|
|
- "test_id": work-role id that this question adheres to
|
|
|
|
- "test_type": either knowledge or performance
|
|
|
|
- "question_id": unique question id (can be anything)
|
|
|
|
- "question_name": actual question name, should be the same as the folder that the question exists in
|
|
|
|
- "topic": topic of the question
|
|
|
|
- "network": network where the test will be administered
|
|
|
|
- "language": programming language for the question
|
|
|
|
- "work-roles": this is an array of work-role id strings
|
|
|
|
- "KSATs": an array of KSAT mappings for this material
|
|
|
|
- "map_for": either 'training' or 'eval'
|
|
|
|
|
|
|
|
Training required Field Information
|
|
|
|
- "course": the course for this training rel-link
|
|
|
|
- "module": the module of the associated rel-link
|
|
|
|
- "topic": the topic of the rel-link
|
|
|
|
- "subject": the subject of the rel-link
|
|
|
|
- "KSATs": an array of KSAT mappings for this material
|
|
|
|
- "network": network where the test will be administered
|
|
|
|
- "work-roles": this is an array of work-role id strings
|
|
|
|
- "topic_path": relative path from the root of the material repo
|
|
|
|
- "map_for": either 'training' or 'eval'
|
|
|
|
This section describes the *.rel-links.json file; rel is short for relation. There will be many of these files inside the 'rel-links' folder that will describe what KSAT and proficiency actual training/evaluation material adheres to. These file will be used in the pipeline to create metrics and visualization for the MTTL. You can find the template for these json object in the [json_templates.py](https://gitlab.com/90cos/mttl/-/blob/master/scripts/json_templates.py) file under the `trn_rel_link_item_template()` and `evl_rel_link_item_template()` functions.
|
|
|
|
|
|
|
|
## Pipeline Overview
|
|
|
|
|
| ... | ... | |