Merge pull request 'new' (!156) from dev_docs into development

Reviewed-on: #156
This commit is contained in:
mik-tf 2024-10-23 03:58:34 +00:00
commit 4a8656ff94

View File

@ -5,6 +5,7 @@
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Steps](#steps)
- [Update the Book](#update-the-book)
---
@ -89,4 +90,24 @@ Note that you will need to adjust the local path of the git repo and the docker
- If you need to update the docker Hero image, run the following line:
```
docker pull ghcr.io/scottyeager/hero:latest
```
## Update the Book
You can use [VSCodium](https://manual.grid.tf/documentation/system_administrators/computer_it_basics/git_github_basics.html#vs-codium) to update files of the Mdbook.
- Open VSCodium
- Open the directory where the repo is located, e.g.
```
cd ~/code/git.ourworld.tf/tfgrid/info_tfgrid
```
- Make changes and save the files
- Redeploy Hero Mdbook
- With a path:
```
hero mdbook -p /root/code/git.ourworld.tf/tfgrid/info_tfgrid/heroscript/tech
```
- With a URL (make sure to pull the changes with `git pull`):
```
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/tech
```