diff --git a/docs/hero_mdbook_docker.md b/docs/hero_mdbook_docker.md index 88c75cf..79034a5 100644 --- a/docs/hero_mdbook_docker.md +++ b/docs/hero_mdbook_docker.md @@ -37,14 +37,26 @@ Note that you will need to adjust the local path of the git repo and the docker ``` sudo docker exec -it herodocker bash ``` -- Set git globally 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**: - ``` - hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/projectinca -gp - ``` +- Git configuration + - Set git lobally with a safe directory + ``` + git config --global --add safe.directory /root/code/git.ourworld.tf/tfgrid/info_tfgrid + ``` + - Set your name and email to be able to push changes + ``` + git config --global user.email "you@example.com" + git config --global user.name "Your Name" + ``` +- You can now use Hero normally, e.g. with **projectinca** + - With a URL: + ``` + hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/projectinca + ``` + - With a path: + ``` + hero mdbook -p /root/code/git.ourworld.tf/tfgrid/info_tfgrid/heroscript/projectinca + ``` + - 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/