Update Academy First Page #57
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 |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| <div class="academy-summary"> | ||
| <h3>Welcome to dev environment for your Academy</h3> | ||
| <p> | ||
| The Layer5 Cloud Academy is a modular learning management system (LMS) designed for building learning paths and | ||
| interactive, hands-on challenges. This integration allows you to embed live visualizations, interactive | ||
| designs, and contextual experiences directly into your courses. | ||
| </p> | ||
| <div> | ||
| <h4>Things to Keep in Mind</h4> | ||
| <ul> | ||
| <li>The content will be published to <a href="https://cloud.layer5.io/academy/" | ||
| target="_blank">cloud.layer5.io/academy</a> only after a release is made in the Academy Repository. | ||
| </li> | ||
| <li>The preview you see here uses default theme colors. On <a href="https://cloud.layer5.io/academy" | ||
| target="_blank">cloud.layer5.io/academy</a>, styles will match your organisation's selected theme. | ||
| </li> | ||
| <li> | ||
| It’s a good practice to update the theme before creating a new release or when you notice that your | ||
| local preview is missing recent design changes. | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| <div class="example"> | ||
| <h4>Academy Example</h4> | ||
| <p> | ||
| The | ||
| <a href="https://github.com/layer5io/academy-example">academy-example</a> | ||
| is a starter template for creating custom learning paths and courses on the Layer5 Academy. It provides the | ||
| necessary file structure and a working example to help you get started quickly. | ||
| </p> | ||
| </div> | ||
| <div class="theme"> | ||
| <h4>Academy Theme</h4> | ||
| The | ||
| <a href="https://github.com/layer5io/academy-theme">academy-theme</a> | ||
| provides the core layout, style, and features for your learning path. Regularly updating it ensures you benefit | ||
| from | ||
| the latest improvements and bug fixes. | ||
| <p> | ||
| Latest Academy Theme Version: <span id="theme-version">Loading...</span> | ||
| </p> | ||
| <p> | ||
| To upgrade to the latest theme version, run: <code>make theme-update</code> | ||
| </p> | ||
| </div> | ||
|
|
||
| <div class="structure"> | ||
| <h4>Academy Structure</h4> | ||
| <h5>Core Directories</h5> | ||
| Now, inside your academy-example project, you should see the following top-level folders. | ||
| <ul> | ||
| <li> | ||
| <strong>content/learning-paths/your-organization-uid/</strong> This content directory is where all your | ||
| written | ||
| material lives. | ||
| The | ||
| folder hierarchy you create here directly defines the navigation and organization of your learning | ||
| paths. | ||
| </li> | ||
| <li> | ||
| <strong>layouts/shortcodes/your-organization-uid/</strong> This layouts directory is for advanced use. | ||
| You can | ||
| place custom | ||
| Hugo | ||
| Shortcodes here if you need special reusable components. | ||
|
Comment on lines
+62
to
+65
Contributor
There was a problem hiding this comment. It seems they are listed on one line in your screenshot?
Contributor
There was a problem hiding this comment. Which is good. They shouldn't be on multiple lines here, though.... at least not in terms of cleanliness. They render on a the same line, which makes this acceptable. |
||
| </li> | ||
| </ul> | ||
| <h5>Content Hierarchy</h5> | ||
|
Contributor
There was a problem hiding this comment. This is incomplete. Either the rest of the content types need to be represented or a note needs to be included to say that this is only part of what is supported and a hyperlink included to Layer5 Docs with the full list. |
||
| <pre><code> | ||
| learning-paths/ | ||
| └── mastering-kubernetes/ // <-- Learning Path | ||
| ├── _index.md | ||
| ├── advanced-networking/ // <-- Course 1 | ||
| │ └── _index.md | ||
| └── core-concepts/ // <-- Course 2 | ||
| ├── _index.md | ||
| ├── course-exam.md // <-- Course Exam (Test) | ||
| └── 01-pods-and-services/ // <-- Module | ||
| ├── _index.md | ||
| ├── 01-pods.md // <-- Page 1 | ||
| ├── 02-services.md // <-- Page 2 | ||
| ├── 03-knowledge-check.md // <-- Test | ||
| ├── 04-hands-on-lab.md // <-- Lab | ||
| └── arch.png // <-- Image | ||
| </code></pre> | ||
| <p>The _index.md file within a folder is crucial as it defines the metadata for that level.</p> | ||
| <h5>Front matter</h5> | ||
| <p> | ||
| Front matter is the configuration block at the top of every content file that defines its metadata. The most | ||
| critical field is type, which tells the Academy how to render the content. | ||
| </p> | ||
|
|
||
| </div> | ||
| <p> | ||
| <strong>Need help? | ||
| <a href="https://docs.layer5.io/cloud/academy/" target="_blank"> | ||
| Documentation | ||
| </a>| | ||
| <a href="https://layer5.io/company/contact" target="_blank"> | ||
| Contact Us | ||
| </a> | ||
| </strong> | ||
| </p> | ||
| </div> | ||
|
|
||
| <script> | ||
| async function fetchThemeVersion() { | ||
| const res = await fetch("https://api.github.com/repos/layer5io/academy-theme/releases/latest"); | ||
| const data = await res.json(); | ||
|
|
||
| if (res.ok) { | ||
| document.getElementById("theme-version").textContent = data.tag_name || data.name; | ||
| } else { | ||
| document.getElementById("theme-version").textContent = "Could not fetch version"; | ||
| } | ||
| } | ||
|
|
||
| fetchThemeVersion(); | ||
| </script> | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we hardcode the latest version?