Skip to content

Commit c564c14

Browse files
committed
docs: add instructions for upgrading to a new version of the academy theme
Signed-off-by: kirti763 <kg4180553@gmail.com>
1 parent 52e9c53 commit c564c14

File tree

1 file changed

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

1 file changed

+25
-0
lines changed

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,31 @@ This action will automatically trigger the workflow, and your content will be de
274274

275275
![Release Example](./images/release-publish.gif)
276276

277+
## Upgrading the Academy Theme
278+
279+
The Layer5 Academy uses a maintained Hugo theme called [`academy-theme`](https://github.com/layer5io/academy-theme). As improvements are made to the theme, it is important to keep your local copy up to date to benefit from the latest features and fixes.
280+
281+
To upgrade to the latest theme version, run:
282+
```bash
283+
make theme-upgrade
284+
```
285+
286+
This will trigger a sequence that updates the theme dependencies and applies the latest modules:
287+
```bash
288+
hugo mod get -u
289+
hugo: collected modules in 1707 ms
290+
go: downloading github.com/layer5io/academy-theme v0.1.6
291+
go: upgraded github.com/layer5io/academy-theme v0.1.5 => v0.1.6
292+
go: upgraded github.com/twbs/bootstrap v5.3.6+incompatible => v5.3.7+incompatible
293+
```
294+
295+
#### When should you upgrade the theme?
296+
297+
- Before creating a release, to ensure you are using the most up-to-date theme.
298+
- If your preview or build seems outdated or missing recent design improvements.
299+
- After any update to the `academy-theme` repository is announced.
300+
> Run `hugo mod graph` to inspect which version of the theme you are currently using.
301+
277302
## Frequently Asked Questions
278303

279304
1. **Why is my workflow failing with a `401 Unauthorized` or `user must be logged in` error?**

0 commit comments

Comments
 (0)