Skip to content

docs: add academy debugging guide using layer 5 cloud events #731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions content/en/cloud/academy/extending-the-academy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,36 @@ For example, a Learning Path titled "Mastering Kubernetes" might contain:
{{< alert type="warning" title="Content Isolation" >}}
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/).
{{< /alert >}}

### Debugging Content Uploads Using Events

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).

To view publishing logs:

1. Navigate to **Settings > Events**
2. Switch to the **Audit** tab
3. Apply a filter using the action type:
`AcademyUpserted`
This will show all attempts to upload content, including which ones failed and why.

**Common Errors You Might See**
- **Duplicate IDs**
Two lessons or paths using the same identifier. You can fix this by renaming or regenerating unique IDs.

- **Invalid Content Type**
For example,
Instead of
```yaml
type: "learning-paths"
```
it should be:
```yaml
type: "learning-path"
```
- **Missing Required Fields**
Ensure that title, description, and type are included in the content’s frontmatter.

{{< alert type="info" title="Tip" >}}
Use the event filter `AcademyRegisteredToContent` to track user activity, like who enrolled in which learning path.
{{< /alert >}}