Skip to content

Commit e779f57

Browse files
committed
docs: add academy debugging guide using layer 5 cloud events
Signed-off-by: kirti763 <kg4180553@gmail.com>
1 parent 52e9c53 commit e779f57

File tree

1 file changed

+33
-0
lines changed
  • content/en/cloud/academy/extending-the-academy

1 file changed

+33
-0
lines changed

content/en/cloud/academy/extending-the-academy/index.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,36 @@ For example, a Learning Path titled "Mastering Kubernetes" might contain:
4848
{{< alert type="warning" title="Content Isolation" >}}
4949
To ensure security and isolation, all of your content files must be placed within a directory named for your organization UUID. You'll learn the specifics of how to do this in our [hands-on tutorial](/cloud/academy/creating-your-learning-path/).
5050
{{< /alert >}}
51+
52+
### Debugging Content Uploads Using Events
53+
54+
If your content is not appearing in the Academy after a GitHub release, it may have failed to publish. You can troubleshoot these issues using the **Events** section in [Layer5 Cloud](https://cloud.layer5.io).
55+
56+
To view publishing logs:
57+
58+
1. Navigate to **Settings > Events**
59+
2. Switch to the **Audit** tab
60+
3. Apply a filter using the action type:
61+
`AcademyUpserted`
62+
This will show all attempts to upload content, including which ones failed and why.
63+
64+
**Common Errors You Might See**
65+
- **Duplicate IDs**
66+
Two lessons or paths using the same identifier. You can fix this by renaming or regenerating unique IDs.
67+
68+
- **Invalid Content Type**
69+
For example,
70+
Instead of
71+
```yaml
72+
type: "learning-paths"
73+
```
74+
it should be:
75+
```yaml
76+
type: "learning-path"
77+
```
78+
- **Missing Required Fields**
79+
Ensure that title, description, and type are included in the content’s frontmatter.
80+
81+
{{< alert type="info" title="Tip" >}}
82+
Use the event filter `AcademyRegisteredToContent` to track user activity, like who enrolled in which learning path.
83+
{{< /alert >}}

0 commit comments

Comments
 (0)