Skip to content

Commit 4dd4f93

Browse files
authored
Merge pull request #731 from kirti763/add-debug-events-doc
docs: add academy debugging guide using layer 5 cloud events
2 parents 2de2f59 + f66421e commit 4dd4f93

File tree

1 file changed

+34
-0
lines changed
  • content/en/cloud/academy/creating-content/creating-your-learning-path

1 file changed

+34
-0
lines changed

content/en/cloud/academy/creating-content/creating-your-learning-path/index.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -431,3 +431,37 @@ Use AWS S3 with signed URLs:
431431
<video src="{{</* s3_signed_url path="training/private.mp4" */>}}">
432432
```
433433
</details>
434+
435+
<details>
436+
<summary>8. How do I debug using Layer5 Cloud Events?</summary>
437+
438+
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).
439+
440+
To view publishing logs:
441+
1. Navigate to **Settings > Events**
442+
2. Switch to the **Audit** tab
443+
3. Apply a filter using the action type:
444+
`AcademyUpserted`
445+
This will show all attempts to upload content, including which ones failed and why.
446+
447+
**Common Errors You Might See**
448+
- **Duplicate IDs**
449+
Two lessons or paths using the same identifier. You can fix this by renaming or regenerating unique IDs.
450+
451+
- **Invalid Content Type**
452+
For example,
453+
Instead of
454+
```yaml
455+
type: "learning-paths"
456+
```
457+
it should be:
458+
```yaml
459+
type: "learning-path"
460+
```
461+
- **Missing Required Fields**
462+
Ensure that title, description, and type are included in the content’s frontmatter.
463+
464+
{{< alert type="info" title="Tip" >}}
465+
Use the event filter `AcademyRegisteredToContent` to track user activity, like who enrolled in which learning path.
466+
{{< /alert >}}
467+
</details>

0 commit comments

Comments
 (0)