You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/cloud/academy/creating-content/instructor-console-guide/index.md
+55-53Lines changed: 55 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,80 +7,82 @@ categories: [Academy]
7
7
tags: [Academy]
8
8
---
9
9
10
-
The Instructor Console is your central command center for the Layer5 Academy. It's where you can get a bird's-eye view of your educational content and dive deep into how learners are engaging with it. Here, you can track learner progress, analyze test performance, and manage all of your academy's content and metrics.
10
+
The [Instructor Console](https://cloud.layer5.io/academy/instructors-console) serves as your command center for the Layer5 Academy, providing both a comprehensive overview of your content and detailed insights into learner engagement.
11
11
12
12
### Gaining Access
13
13
14
-
To view the Instructor Console, you must be assigned the Academy Admin role.
14
+
To view the Instructor Console, you must have the **Academy Admin** role or be an **organization admin**.
The Instructor Console and custom academy features are available exclusively for organizations on an Enterprise plan. [Learn more](https://layer5.io/pricing)
18
18
{{< /alert >}}
19
19
20
-
If you are part of an organization with an Enterprise plan but do not see the console in your navigation, you'll need to request access. Reach out to your organization's administrator. Ask them to assign the **Academy Admin** role to your user account.
20
+
### Using the Content Creation Tool
21
21
22
-
Once the role is assigned, the Instructor Console will become visible in your navigation menu.
22
+
The Instructor Console includes a Content Creation Tool to help you develop new learning materials. It's a simple, guided process that generates the initial configuration for your content.
23
23
24
-
## Layout Overview
24
+
This tool walks you through three quick steps to create your content's boilerplate configuration.
25
25
26
-
The Instructor Console is organized into several key sections that provide comprehensive insights into your academy's performance and learner engagement.
1.**Basic Information**: First, you'll provide the essential details for your new content, such as its **Content Type** (Learning Path/Certification/Challenge), **Title**, and **Description**.
29
29
30
-
These four cards at the top provide your most immediate, high-level statistics:
| Primary Goal | To teach and guide through a comprehensive curriculum. | To solve a specific, hands-on problem in a competitive scenario. | To validate and prove existing knowledge through formal examination. |
33
+
| Main Content | Lessons, informational pages, labs, and progressive assessments. | A set of instructions for a practical task and a validation mechanism. | A series of exams, potentially with a brief study guide. |
34
+
| Outcome | Acquired knowledge and skills. | A score and rank status. | An optional, paid official certificate and a verifiable badge.|
31
35
32
-
-**Content Version**: This shows the version of the academy module your learners are currently using.
33
-
-**Total Learners**: A running total of every unique user who has ever registered for any of your content.
34
-
-**Active Learners**: The number of learners who are currently "in-progress." They have registered for content but have not yet completed it.
35
-
-**Total Test Taken**: The total number of times any test has been attempted across all your content. This counts retakes as well.
36
+
2.**Content Details**: Next, you'll refine additional properties for the content.
3.**Copy Template**: Finally, the Creation Tool presents you with a **"Generated Front Matter & Setup Guide"**. You'll copy this YAML configuration and place it at the top of the corresponding `_index.md` file in your content repository.
38
39
40
+
{{< alert type="info" title="Console Creation Tool vs. Full Guides" >}}
41
+
Think of the console's creation tool as a 'quick start' generator. It generates the necessary configuration boilerplate, but the detailed work of writing, structuring files, and publishing your content is done in your Git repository. For that, you'll need to follow our [comprehensive guides](/cloud/academy/creating-content/).
42
+
{{< /alert >}}
39
43
40
-
### Using the Content Creation Tool
44
+
##Understanding the Dashboard
41
45
42
-
The Instructor Console includes a Content Creation Tool to kickstart the development of new learning materials. It's a simple, guided process to help you generate the initial configuration for your content.
46
+
Below the creation tool is the main dashboard, which provides an overview of your academy's statistics through a series of widgets.
43
47
44
-
This tool guides you through three quick steps to generate your content's boilerplate configuration.
The three cards display your most important, high-level statistics:
47
51
52
+
-**Total Learners**: A running count of every unique user who has registered for any of your content.
53
+
-**Active Learners**: The number of learners currently working through content who haven't completed it yet.
54
+
-**Total Test Taken**: The total number of test attempts across all your content, including retakes.
48
55
49
-
1.**Basic Information**: First, you'll provide the essential details for your new content, such as its **Content Type** (Learning Path/Certification/challenge), **Title**, and **Description**.
| Primary Goal | To teach and guide through a comprehensive curriculum. | To solve a specific, hands-on problem in a competitive scenario. | To validate and prove existing knowledge through formal examination. |
54
-
| Main Content | Lessons, informational pages, labs, and progressive assessments. | A set of instructions for a practical task and a validation mechanism. | A series of exams, potentially with a brief study guide. |
55
-
| Outcome | Acquired knowledge and skills. | A score, rank status. | An optional, paid official certificate and a verifiable badge.|
58
+
### Content Details
56
59
57
-
2.**Content Details**: Next, you'll refine additional properties for the content.
60
+
This widget provides a quick inventory of your academy's content:
58
61
59
-
3.**Copy Template**: Finally, the Creation Tool presents you with a **"Generated Front Matter & Setup Guide"**. You will copy this YAML configuration and place it at the top of the corresponding `_index.md` file in your content repository.
62
+
-**Content Version**: Shows the current version of the academy module your learners are using.
63
+
-**Content Stats**: Shows a quick count of the different types of content you've published. Each category is interactive; clicking on one will take you to the Academy Catalog, pre-filtered to show all your content of that type.
60
64
61
-
{{< alert type="info" title="Console Creation Tool vs. Full Guides" >}}
62
-
Think of the console's creation tool as a 'quick start' generator. It generates the necessary configuration boilerplate, but the detailed work of writing, structuring files, and publishing your content is done in your Git repository. For that, you'll need to follow our [comprehensive guides]().
This donut chart provides an immediate visual summary of your learner base. It shows the proportion of learners who are currently working through content (`registered`) compared to those who have successfully finished their content (`completed`).
68
70
69
-
This section offers a more granular look at your content's structure and your learners' overall status.
-**Content Stats**: This card gives you a quick count of the different types of content you've published. Each category is interactive; clicking on one will take you to the Academy Catalog, pre-filtered to show all your content of that type.
73
+
### Content Metrics
72
74
73
-
-**Registration Status**: This donut chart provides an immediate visual summary of your learner base. It shows the proportion of learners who are currently working through content (`registered`) compared to those who have successfully finished their content (`completed`).
75
+
It lists your content and ranks them by the total number of registrations, giving you a clear view of what learners find most engaging. Each title is a direct link, allowing you to navigate straight to it.
74
76
75
-
-**Content Metrics**: Think of this as a leaderboard for your content. It lists your content and ranks them by the total number of registrations, giving you a clear view of what learners find most engaging. Each title is a direct link, allowing you to navigate straight to it.
77
+
76
78
77
-
### The All Learners Report
79
+
### All Learners Report
78
80
79
-
The Learners section provides a detailed, interactive table that allows you to track individual progress, see who is taking which content, and get a granular view of your learner base.
81
+
The All Learners section provides a detailed, interactive table that allows you to track individual progress, see who is taking which content, and get a granular view of your learner base.
80
82
81
83
82
84
83
-
**Understanding the Table**
85
+
#### Understanding the Table
84
86
85
87
Each row in the table represents a single user's registration for a specific content. Here's what each column means:
86
88
@@ -92,34 +94,34 @@ Each row in the table represents a single user's registration for a specific con
92
94
-`Completed` (Green): The learner has successfully finished all required parts of the content.
93
95
-`Withdrawn` (Red): The learner has unenrolled from the content.
94
96
95
-
**Filtering and Finding Learners**
97
+
#### Filtering and Finding Learners
96
98
97
-
To find specific groups of learners, use the filter control located at the top-right of the table.
99
+
To find specific groups of learners, use the filter control at the top-right of the table.
98
100
99
101
-**Filter by Content Type**: Want to see everyone enrolled only in Certifications? Select `Certification` from the 'Content Type' filter.
100
102
-**Filter by Status**: Need a list of everyone who has successfully finished content? Select `Completed` from the 'Status' filter.
101
103
102
-
**Customizing Your View**
104
+
#### Customizing Your View
103
105
104
-
To tailor the report to your needs, you can customize which columns are visible. Click the **View Columns** button at the top-right of the table.
106
+
You can customize which columns are visible to tailor the report to your specific needs. Click the **View Columns** button at the top-right of the table. A dropdown menu will appear, allowing you to check or uncheck columns to show or hide them.
105
107
106
-
A dropdown menu will appear, allowing you to check or uncheck columns to show or hide them. This is particularly useful for simplifying the view to focus on specific data.
108
+
107
109
108
-
**Navigating Through Pages**
110
+
#### Navigating Through Pages
109
111
110
-
When you have a large number of registrations, the report is split into multiple pages. Use the controls at the bottom-right of the table to navigate:
112
+
If there are a large number of learner registrations, the report is split into multiple pages. Use the controls at the bottom of the table to navigate through the data:
111
113
112
-
**Rows per page**: Select how many records you want to see on a single page (e.g., 10, 25, 50).
114
+
**Rows per page**: Choose how many records to display on each page (e.g., 10, 25, 50).
113
115
114
116
### Analyzing Test Performance
115
117
116
118
The final section is dedicated to analyzing the performance of your assessments.
These statistics provide a high-level summary of all test activities in your academy.
123
125
124
126
-**Pass/Fail Summary Bar:** This bar chart gives you an at-a-glance comparison of the total number of passed attempts (green) versus failed attempts (red) across all tests.
125
127
@@ -128,21 +130,21 @@ The statistics on the left provide a high-level summary of all test activities i
128
130
-**Easiest Test:** The quiz with the highest pass-to-fail ratio.
129
131
-**Most Attempted Test:** The quiz that learners have attempted the most times, regardless of the outcome.
130
132
131
-
#### Detailed Test Metrics
133
+
#### Test Metrics
132
134
133
-
The **Test Metrics** list on the right provides a detailed performance breakdown for each individual test. Each test title in this list is a clickable link that will take you directly to that assessment.
135
+
The **Test Metrics** list provides a detailed performance breakdown for each individual test. Each test title in this list is a clickable link that will take you directly to that assessment.
134
136
135
-
The percentage on the far right (e.g., `33%`) shows the overall pass rate for that specific test.
137
+
The percentage (e.g., `33%`) shows the overall pass rate for that specific test.
136
138
137
139
{{< alert type="info" title="Identifying Problem Areas" >}}
138
-
Use this list to quickly identify which specific exams are causing the most trouble for your learners. A low pass rate on a particular quiz might indicate that the source material needs clarification or that the questions themselves are unclear.
140
+
Use this list to quickly identify which specific assessments are causing the most trouble for your learners. A low pass rate on a particular assessment might indicate that the source material needs clarification or that the questions themselves are unclear.
139
141
{{< /alert >}}
140
142
141
143
## Frequently Asked Questions
142
144
143
145
<details>
144
146
<summary>I'm my organization's administrator. Can I assign Academy Admin roles?</summary>
145
-
Yes, you can assign Academy Admin roles to users within your organization. As an administrator, you have the ability to manage user permissions and roles through your organization's user management system.
147
+
Yes, you can assign Academy Admin roles to users within your organization. As an administrator, you have the ability to manage user permissions and roles in [user page](https://cloud.layer5.io/identity/users).
0 commit comments