Skip to content

Commit 1cba721

Browse files
authored
Merge pull request #772 from zihanKuang/add-console
docs: Add Instructor Console Guide`
2 parents 27dd10a + 2529134 commit 1cba721

File tree

10 files changed

+206
-0
lines changed

10 files changed

+206
-0
lines changed

content/en/cloud/academy/creating-content/instructor-console-guide/images/academy-admin.svg

Lines changed: 1 addition & 0 deletions
Loading
46.4 KB
Loading
30.7 KB
Loading
137 KB
Loading
3.31 MB
Loading
94.1 KB
Loading
18.3 KB
Loading
198 KB
Loading
219 KB
Loading
Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
---
2+
title: "Academy Instructor Console Guide"
3+
weight: 5
4+
description: >
5+
A comprehensive guide to using the Instructor Console. Learn how to track learner progress, analyze test performance, and manage your academy's content and metrics.
6+
categories: [Academy]
7+
tags: [Academy]
8+
---
9+
10+
The [Academy 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+
12+
### Gaining Access
13+
14+
To view the Instructor Console, you must have the **Academy Admin** role or be an **organization admin**.
15+
16+
{{< alert type="info" title="Enterprise Feature" >}}
17+
The Instructor Console and custom academy features are available exclusively for organizations on an Enterprise plan. [Learn more](https://layer5.io/pricing)
18+
{{< /alert >}}
19+
20+
![Academy Admin Role](./images/academy-admin.svg)
21+
22+
### Using the Content Creation Tool
23+
24+
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.
25+
26+
This tool walks you through three quick steps to create your content's boilerplate configuration.
27+
28+
![Content Creation Tool](./images/create-content-model.gif)
29+
30+
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**.
31+
32+
| Feature | Learning Path | Challenge | Certification |
33+
| :--- | :--- | :--- | :--- |
34+
| 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. |
35+
| 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. |
36+
| Outcome | Acquired knowledge and skills. | A score and rank status. | An optional, paid official certificate and a verifiable badge.|
37+
38+
2. **Content Details**: Next, you'll refine additional properties for the content.
39+
40+
> Need help understanding these properties? [Learn more](/cloud/academy/creating-content/creating-your-learning-path/#2-structure-your-learning-path).
41+
42+
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.
43+
44+
{{< alert type="info" title="Console Creation Tool vs. Full Guides" >}}
45+
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/).
46+
{{< /alert >}}
47+
48+
## Understanding the Dashboard
49+
50+
Below the creation tool is the main dashboard, which provides an overview of your academy's statistics through a series of widgets.
51+
52+
### Core Metrics
53+
54+
These charts display your most important, high-level statistics, giving you a snapshot of your academy's health:
55+
56+
![Core Metrics Dashboard](./images/core-metrics.png)
57+
58+
- **Total Learners**: Represents the overall reach of your academy. This is the total number of people who have ever shown interest in your content.
59+
- **Active Learners**: Measures current engagement. This is the number of learners currently working through content, giving you an idea of your active student body.
60+
- **Total Test Taken**: Indicates the level of interaction with your assessments.
61+
62+
**Strategic Uses**
63+
- Monitor Total Learners growth - steady increases indicate growing academy reach
64+
- Analyze Total Test Taken - high counts suggest challenging material requiring retakes, low counts may indicate learners avoiding assessments, assessments not being mandatory, or content being too easy
65+
66+
{{< alert type="info" title="What Defines an 'Active Learner'?" >}}
67+
The **Active Learners** metric is a key indicator for engagement and billing, calculated based on the current status of content registrations.
68+
69+
Specifically, it counts the number of registrations that are currently in the `Registered` status. This represents learners who have enrolled in your content but have not yet `Completed` it. It gives you a clear picture of your "in-progress" student body.
70+
{{< /alert >}}
71+
72+
### Content Details
73+
74+
This widget provides a quick inventory of your academy's content:
75+
76+
- **Content Version**: Shows the version of the academy content your learners are using.
77+
- **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.
78+
79+
![Content Details](./images/content-details.png)
80+
81+
**Strategic Uses**
82+
- Monitor content version updates - when version numbers don't change, check if your GitHub releases and Layer5 Cloud deployments are complete
83+
- Track content distribution - if one content type dominates, consider diversifying your academy offerings
84+
85+
{{< alert type="info" title="Content Versioning and Release Process" >}}
86+
If you've recently published new content but don't see the version number updated here, it is likely due to the platform's two-stage release process. Your updates become fully live only after both your content repository's GitHub Release is created and the subsequent Layer5 Cloud release is deployed.
87+
88+
For a complete walkthrough of this workflow, see the [Publishing Your Content Guide](/cloud/academy/creating-content/creating-your-learning-path/#5-publishing-your-learning-path).
89+
{{< /alert >}}
90+
91+
### Learner Registration
92+
93+
This chart provides an immediate visual summary of your learner base.
94+
95+
![Learner Registration](./images/learner-registration.png)
96+
97+
While the chart will only display statuses that currently have data, the system recognizes the following definitions, each represented by a specific color:
98+
- `Registered` (Blue): The learner has enrolled but has not yet completed the content.
99+
- `Completed` (Green): The learner has successfully finished all required parts of the content.
100+
- `Withdrawn` (Red): The learner has unenrolled from the content.
101+
102+
**Strategic Uses**
103+
- Monitor the `registered` vs `completed` ratio - if `registered` grows much faster than `completed`, your content may be too difficult or lacks engagement
104+
- Watch for large `withdrawn` segments - high withdrawal rates may indicate content quality issues or poor learner experience
105+
- Track completion rates over time - improving rates suggest content optimization success, declining rates may signal new content challenges
106+
107+
### Content Metrics
108+
109+
It lists your content and ranks them by the total number of passes, giving you a clear view of what learners find most engaging. Each title is a direct link, allowing you to navigate straight to it.
110+
111+
![Content Metrics](./images/content-metrics.png)
112+
113+
**Strategic Uses**
114+
- Identify top-performing content - high registration numbers indicate strong learner interest, use this to understand what resonates
115+
- Monitor new content launch performance - if new Learning Paths get few registrations, check marketing or content positioning
116+
- Compare content performance - if similar topics have very different registration numbers, investigate what makes the difference
117+
118+
### All Learners Report
119+
120+
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.
121+
122+
![All Learners Report](./images/learners.png)
123+
124+
#### Understanding the Table
125+
126+
Each row in the table represents a single user's registration for a specific content. Here's what each column means:
127+
128+
- **USER**: The learner's information. Clicking the avatar will take you to their public user profile.
129+
- **CURRICULA**: The specific content the user is enrolled in. Clicking the title will navigate you directly to that content.
130+
- **REGISTERED AT**: A timestamp indicating when the user enrolled. This is shown as a relative time (e.g., "6 hours ago") and will display the full date on hover.
131+
- **STATUS**: The learner's current standing in the content. The definition for each status is provided in the Learner Registration section [above](#learner-registration).
132+
133+
#### Filtering and Finding Learners
134+
135+
To find specific groups of learners, use the filter control at the top-right of the table.
136+
137+
- **Filter by Content Type**: Want to see everyone enrolled only in Certifications? Select `Certification` from the 'Content Type' filter.
138+
- **Filter by Status**: Need a list of everyone who has successfully finished content? Select `Completed` from the 'Status' filter.
139+
140+
#### Customizing Your View
141+
142+
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.
143+
144+
![Filtering](./images/filter.png)
145+
146+
#### Navigating Through Pages
147+
148+
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:
149+
150+
**Rows per page**: Choose how many records to display on each page (e.g., 10, 25, 50).
151+
152+
**Strategic Uses**
153+
- Identify at-risk learners - filter for users in `Registered` status for over 30 days, they may need support or content may be too challenging
154+
- Gather feedback from recent completions - contact learners who moved to `Completed` status within the last week while content is fresh in their minds
155+
156+
### Analyzing Test Performance
157+
158+
The final section is dedicated to analyzing the performance of your assessments.
159+
160+
![Test Statistics Overview](./images/test-stats.png)
161+
162+
#### Test Stats
163+
164+
These statistics provide a high-level summary of all test activities in your academy.
165+
166+
- **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.
167+
168+
- **Insight Cards:** These three cards automatically surface key trends and outliers from your data:
169+
- **Most Difficult Test:** The quiz with the lowest pass-to-fail ratio, helping you identify challenging content.
170+
- **Easiest Test:** The quiz with the highest pass-to-fail ratio.
171+
- **Most Attempted Test:** The quiz that learners have attempted the most times, regardless of the outcome.
172+
173+
#### Test Metrics
174+
175+
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.
176+
177+
The percentage (e.g., `33%`) shows the overall pass rate for that specific test.
178+
179+
{{< alert type="info" title="Identifying Problem Areas" >}}
180+
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.
181+
{{< /alert >}}
182+
183+
**Strategic Uses**
184+
- Investigate difficult tests - when a quiz appears in the **Most Difficult Test** card with low pass rates, review the content and questions for clarity
185+
- Monitor test attempt patterns - if **Most Attempted Test** has low pass rates, learners may be struggling with fundamental concepts
186+
- Use pass rate trends - improving pass rates suggest content optimization success, declining rates may indicate new content is too challenging
187+
188+
## Frequently Asked Questions
189+
190+
<details>
191+
<summary>I'm my organization's administrator. Can I assign Academy Admin roles?</summary>
192+
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).
193+
</details>
194+
195+
<details>
196+
<summary>Can I export the All Learners Report to a CSV or Excel file?</summary>
197+
198+
Currently, the Instructor Console does not have a built-in feature to export the report directly to a file format like CSV. If you need this functionality urgently, please contact us at https://layer5.io/company/contact
199+
</details>
200+
201+
<details>
202+
<summary>Does "Total Test Taken" show the number of unique learners who took tests?</summary>
203+
204+
No. The "Total Test Taken" metric is a raw count of all attempts, including retakes by the same user. It is a measure of overall testing activity, not the number of unique learners who have been tested.
205+
</details>

0 commit comments

Comments
 (0)