|
1 | | -Reusable hugo theme module that powers the layer5 academy . |
2 | | -this modules provides the layouts , shortcodes and partials to get academy up and running |
| 1 | +# Academy Theme |
3 | 2 |
|
4 | | -The recommended approach to use this theme is through the academy starter template . |
| 3 | +Reusable Hugo theme module that powers the Layer5 Academy. This module provides |
| 4 | +the layouts, shortcodes, and partials to get academy up and running. |
5 | 5 |
|
6 | | -## Getting started with this theme |
| 6 | +## Getting Started |
7 | 7 |
|
8 | | -The recommended approach to use this theme is through the academy starter template . |
| 8 | +The recommended approach to use this theme is through the |
| 9 | +[academy starter template](https://github.com/layer5io/academy-example). |
| 10 | + |
| 11 | +For comprehensive documentation, visit the |
| 12 | +[official Academy documentation](https://docs.layer5.io/cloud/academy/). |
| 13 | + |
| 14 | +## Content Structure |
| 15 | + |
| 16 | +The Academy uses the following content hierarchy: |
| 17 | + |
| 18 | +### Learning Path → Course → Module |
| 19 | + |
| 20 | +In addition to this core structure, the following content types are available: |
| 21 | + |
| 22 | +- **Lab** - Hands-on practical exercises |
| 23 | +- **Challenge** - Skill assessment challenges |
| 24 | +- **Test** - Knowledge assessments (test, optional-test, |
| 25 | + final-test) |
| 26 | +- **Certification** - Certification programs |
| 27 | + |
| 28 | +## Important Notes |
| 29 | + |
| 30 | +⚠️ **Deprecated Features** |
| 31 | + |
| 32 | +- The `usestatic` shortcode is deprecated and should not be used in new |
| 33 | + content. |
| 34 | + |
| 35 | +## Contributor Guide and Resources |
| 36 | + |
| 37 | +- 📚 [Instructions for contributing to academy-example][contrib] |
| 38 | + - Academy-template [documentation][docs], [example][example], and |
| 39 | + [theme][theme] |
| 40 | +- 🎨 Wireframes and [designs for Layer5 site][figma] in Figma |
| 41 | + ([open invite][figma-invite]) |
| 42 | +- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum][forum] and |
| 43 | + [Layer5 Community Slack][slack] |
| 44 | + |
| 45 | +[contrib]: https://github.com/layer5io/academy-example/blob/master/CONTRIBUTING.md |
| 46 | +[docs]: https://docs.layer5.io/cloud/academy/ |
| 47 | +[example]: https://github.com/layer5io/academy-example/ |
| 48 | +[theme]: https://github.com/layer5io/academy-theme/ |
| 49 | +[figma]: https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs |
| 50 | +[figma-invite]: https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9 |
| 51 | +[forum]: https://discuss.layer5.io |
| 52 | +[slack]: http://slack.layer5.io |
0 commit comments