generated from layer5io/academy-example
-
Notifications
You must be signed in to change notification settings - Fork 13
Update README.md file #91
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
Closed
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
4716a8c
remove duplicate content and add links
Vincamine acb9895
Merge branch 'master' into w-reademe
leecalcote 44f56d0
Merge branch 'master' into w-reademe
leecalcote 903c23a
Add support for mirror fork PRs in GitHub Actions workflow
leecalcote 8a6f5d0
Refactor GitHub Actions workflow to streamline deployment and user se…
leecalcote 0b8ccf7
Merge branch 'master' into w-reademe
hortison File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,9 +3,9 @@ | |
|
||
This repository is a starter template for creating custom learning paths and courses on the [Layer5 Academy](https://cloud.layer5.io/academy/overview). It provides the necessary file structure and a working example to help you get started quickly. | ||
|
||
This guide will walk you through setting up your own content repository, creating courses, and previewing them locally. | ||
> **📖 Complete Documentation:** For comprehensive content creation guidelines, visit the [official Layer5 Academy documentation](https://docs.layer5.io/cloud/academy/creating-content/) | ||
|
||
> For more in-depth documentation, see the official [Layer5 Academy docs](https://docs.layer5.io/cloud/academy/). | ||
This README focuses on the specific setup steps for this starter template. | ||
|
||
## Prerequisites | ||
|
||
|
@@ -47,86 +47,52 @@ First, create a copy of this repository under your own GitHub account. | |
|
||
The Academy platform uses an **Organization ID** to keep content separate and secure. You must get this ID from the Layer5 CLoud before proceeding. | ||
|
||
Once you have your UID, rename the placeholder directories: | ||
Once you have your UUID, rename the placeholder directories: | ||
|
||
- Rename `content/learning-paths/your-org-uid` to `content/learning-paths/<your-organization-uid>` | ||
- Rename `static/your-org-uuid` to `static/<your-organization-uid>` | ||
- Rename `layouts/shortcodes/your-org-uuid` to `layouts/shortcodes/<your-organization-uid>` | ||
- Rename `content/learning-paths/your-org-uuid` to `content/learning-paths/<your-organization-uuid>` | ||
- Rename `static/your-org-uuid` to `static/<your-organization-uuid>` | ||
- Rename `layouts/shortcodes/your-org-uuid` to `layouts/shortcodes/<your-organization-uuid>` | ||
|
||
### 4. Add Your Content | ||
|
||
Now you're ready to create your learning path. The structure is: **Learning Path → Course → Chapter → Lesson**. | ||
|
||
A high-level view of the structure looks like this: | ||
```text | ||
content/ | ||
└── learning-paths/ | ||
├── _index.md | ||
└── <your-organization-uid>/ | ||
└── <your-learning-path>/ | ||
├── _index.md | ||
└── <your-course-1>/ | ||
└── <your-course-2>/ | ||
├── _index.md | ||
└── content/ | ||
└── your-lesson-1.md | ||
└── your-lesson-2.md | ||
``` | ||
|
||
- **Delete the example content** inside `content/learning-paths/<your-organization-uid>/`. | ||
- **Create your folder structure** following the example's hierarchy. | ||
- **Add your lessons** as Markdown (`.md`) files inside the `content` directory of a course. | ||
- **Use frontmatter** at the top of your `_index.md` and lesson files to define titles, descriptions, and weights. | ||
> **📚 Content Creation Guide:** For detailed instructions on structuring learning paths, writing courses, and creating assessments, see the [Content Creation Documentation](https://docs.layer5.io/cloud/academy/creating-content/). | ||
|
||
### 5. Add Assets (Images & Videos) | ||
|
||
Enhance your course with images and other visual aids. To ensure compatibility with the multi-tenant Academy platform, **do not use standard Markdown image links**. Instead, use the `usestatic` shortcode, which generates the correct, tenant-aware path for your assets. | ||
|
||
**How to Add an Image** | ||
The basic structure is: **Learning Path → Course → Chapter → Lesson**. | ||
|
||
1. Place your image file (e.g., `hugo-logo.png`) in your scoped static directory: | ||
|
||
```text | ||
static/<your-organization-uid>/images/hugo-logo.png | ||
``` | ||
2. In your `lesson-1.md` file, embed the image using the `usestatic` shortcode. The `path` is relative to your scoped static folder: | ||
Quick setup steps: | ||
- Delete the example content inside `content/learning-paths/<your-organization-uuid>/` | ||
- Create your folder structure following the example's hierarchy | ||
- Add your lessons as Markdown files with proper frontmatter | ||
|
||
```text | ||
 | ||
``` | ||
|
||
Then the system will automatically convert this into the correct URL when building the site. | ||
### 5. Add Assets (Images & Videos) | ||
|
||
**How to Add a Video** | ||
For this template, place assets in your scoped static directory: `static/<your-organization-uuid>/` | ||
|
||
Use the `usestatic` shortcode for images: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we still have |
||
```text | ||
{{</* card | ||
title="Video: Example" */>}} | ||
<video width="100%" height="100%" controls> | ||
<source src="https://exmaple.mp4" type="video/mp4"> | ||
Your browser does not support the video tag. | ||
</video> | ||
{{</* /card */>}} | ||
 | ||
``` | ||
|
||
> **🎨 Asset Management:** For comprehensive guidelines on adding multimedia content, interactive elements, and assessments, see the [Content Creation Documentation](https://docs.layer5.io/cloud/academy/creating-content/). | ||
|
||
### 6. Local Development | ||
|
||
To preview your content locally, run the Hugo server from the project root: | ||
|
||
```bash | ||
hugo server | ||
make site | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Why are we repeating the build steps here in this README? |
||
``` | ||
|
||
This will start a local server. You can view your content and check for formatting issues before publishing. | ||
|
||
> The local preview uses basic styling. Full Academy branding and styles will be applied after your content is integrated into the cloud platform. | ||
|
||
### 7. Going Live | ||
### 7. Publishing Your Content | ||
|
||
Once your content is complete and tested locally: | ||
Once your content is ready: | ||
|
||
1. Push all your changes to your forked repository on GitHub. | ||
2. **[Connect](https://layer5.io/company/contact) the Layer5 Team** via Slack, email, or by opening a GitHub issue. | ||
3. Provide the URL to your content repository. | ||
1. Push your changes to your forked repository | ||
2. [Contact the Layer5 team](https://layer5.io/company/contact) with your repository URL | ||
3. A Layer5 administrator will integrate your content into the Academy platform | ||
|
||
A Layer5 administrator will then integrate your repository into the main Academy platform. After integration, your learning paths will be visible on the official [Layer5 Cloud site](https://cloud.layer5.io/academy/overview). | ||
> **🚀 Publishing Process:** For detailed information about the publishing workflow and content review process, see the [Academy Documentation](https://docs.layer5.io/cloud/academy/creating-content/). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.