Skip to content

Commit 0a0cc1b

Browse files
authored
Merge pull request #711 from kirti763/update-docs-academy-theme-v2
docs: add instructions for upgrading to a new version of the academy …
2 parents 17011b3 + 810370a commit 0a0cc1b

File tree

1 file changed

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

1 file changed

+33
-0
lines changed

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

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,39 @@ This action will automatically trigger the workflow, and your content will be de
279279
280280
![Release Example](./images/release-publish.gif)
281281
282+
## 6. Ongoing Maintenance and Updates
283+
284+
Once your learning path is live, you may need to perform routine tasks to keep your local environment and dependencies up-to-date.
285+
286+
### Updating the Academy Theme
287+
The [`academy-theme`](https://github.com/layer5io/academy-theme) provides the core layout, style, and features for your learning path. Regularly updating it ensures you benefit from the latest improvements and bug fixes.
288+
289+
To upgrade to the latest theme version, run:
290+
```bash
291+
make theme-upgrade
292+
```
293+
294+
You will see output similar to this as Hugo fetches the new modules:
295+
```bash
296+
hugo mod get -u
297+
hugo: collected modules in 1707 ms
298+
go: downloading github.com/layer5io/academy-theme v0.1.6
299+
go: upgraded github.com/layer5io/academy-theme v0.1.5 => v0.1.6
300+
go: upgraded github.com/twbs/bootstrap v5.3.6+incompatible => v5.3.7+incompatible
301+
```
302+
303+
{{< alert type="info" title="When to Update?" >}}
304+
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.
305+
{{< /alert >}}
306+
307+
### Clearing the Local Cache for Troubleshooting
308+
309+
If you encounter unexpected formatting issues or your content doesn't update correctly during local development, your build cache might be stale. Use the `make clean` command to resolve this.
310+
This command first deletes the local build cache (`public` directory) and then restarts the development server, ensuring you are previewing a fresh build of your content.
311+
```bash
312+
make clean
313+
```
314+
282315
## Frequently Asked Questions
283316
284317
1. **Why is my workflow failing with a `401 Unauthorized` or `user must be logged in` error?**

0 commit comments

Comments
 (0)