dev_docs #154

Merged
mik-tf merged 2 commits from dev_docs into development 2024-10-23 03:51:36 +00:00
Showing only changes of commit c6d20f36d7 - Show all commits

View File

@ -34,6 +34,8 @@ Note that you will need to adjust the local path of the git repo and the docker
- On a terminal window, create the code repository on the local machine
```
mkdir -p ~/code/git.ourworld.tf/tfgrid
cd ~/code/git.ourworld.tf/tfgrid
git clone https://git.ourworld.tf/tfgrid/info_tfgrid
```
- Start Hero docker
```
@ -49,26 +51,26 @@ Note that you will need to adjust the local path of the git repo and the docker
```
- Change directory
```
cd ~/code/git.ourworld.tf/tfgrid
cd ~/code/git.ourworld.tf/tfgrid/info_tfgrid
```
- Git configuration
- Set git lobally with a safe directory
```
git config --global --add safe.directory /root/code/git.ourworld.tf/tfgrid/info_tfgrid
```
- You can now use Hero normally, e.g. with **projectinca**
- You can now use Hero normally, e.g. with **tech**
- With a URL:
```
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/projectinca
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/tech
```
- With a path:
```
hero mdbook -p /root/code/git.ourworld.tf/tfgrid/info_tfgrid/heroscript/projectinca
hero mdbook -p /root/code/git.ourworld.tf/tfgrid/info_tfgrid/heroscript/tech
```
- In this case, you can modify the mdbook on the local machine's git repo that you set in the prerequisites section and the changes will be shown on the docker path
- To view the mdbook on your local browser, run the lines:
```
cd ~/hero/var/mdbuild/projectinca/
cd ~/hero/var/mdbuild/tech/
mdbook serve -n 0.0.0.0
```
- You should be able to view the rendered book at