2.6. Published repository structure

Introduction

There are two structures which can be used when publishing repositories:

1. Default repository structure
2. Flat repository structure

The main difference between the two is that the default structure has an <activity_ID> folder in its <content_repository_ID> folder. <activity_ID> folder is used to store all assessments, container and exam files which belong to the same activity (Goal, Topic, etc.).

Flat structure does not have the <activity_ID> folder, but rather stores all assessments, container and exam files (from all activities) directly to <content_repository_ID> folder.

Default repository structure

Level	Name	Type	Description	Details
1	repository	folder	Root folder for storing all published repositories
2	<content_repository_ID>	folder	These folders contain all data for Repositories with the same ID as the folder name
2	assets	folder	Folder containing all assets used in all Repositories.
2	index.json (1)	file	Basic course structure (id, name and description for every published Repository)	Link
3	<activity_ID>	folder	Folder containing three types of properties each Repository can have (Content containers, assessments and exams)
3	index.json (2)	file	Complete Repository structure	Link
3	<asset_container_ID>	folder	These folders contain all asset files which belong to the same element (e.g. all image files from one accordion)
4	<ID>.container.json	file	Perspective structure and teaching elements data	Link
4	assessments.json	file	Assessments structure and data (questions)	Link
4	<ID>.exam.json	file	Exam structure and data (grouped questions)	Link
4	<asset_file>	file	Individual asset files (images, video, etc.)

Flat repository structure

In order to use the flat repository structure, following line needs to be added to the .env file from project root:

FLAT_REPO_STRUCTURE=1

Level	Name	Type	Description	Details
1	repository	folder	Root folder for storing all published repositories
2	<content_repository_ID>	folder	These folders contain all data for Repositories with the same ID as the folder name
2	assets	folder	Folder containing all assets used in all Repositories.
2	index.json (1)	file	Basic course structure (id, name and description for every published Repository)	Link
3	<ID>.container.json	file	Perspective structure and teaching elements data	Link
3	<ID>.assessments.json	file	Assessments structure and data (questions)	Link
3	<ID>.exam.json	file	Exam structure and data (grouped questions)	Link
3	index.json (2)	file	Complete Repository structure	Link
3	<asset_container_ID>	folder	These folders contain all asset files which belong to the same element (e.g. all image files from one accordion)
4	<asset_file>	file	Individual asset files (images, video, etc.)