tfgrid/info_tfgrid
30
3
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Activity

Merge pull request 'dev_docs' (!154) from dev_docs into development

Browse Source 
Reviewed-on: #154
This commit is contained in:
mik-tf 2024-10-23 03:51:36 +00:00
commit 7416aef04a
2 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/hero_mdbook_docker.md
View File

@ -16,7 +16,7 @@ You can then use a code editor, e.g. VSCodium, to change the files locally and u
## Prerequisites ## Prerequisites
- [Docker engine](https://docs.docker.com/engine/install/ubuntu/) should be installed and running on Linux - [Docker Engine](https://docs.docker.com/engine/install/ubuntu/) should be installed and running on Linux
- [Docker Desktop](https://www.docker.com/products/docker-desktop/) should be installed and running on MacOS and Windows - [Docker Desktop](https://www.docker.com/products/docker-desktop/) should be installed and running on MacOS and Windows
- You need a git repository to work with (here we use **info_tfgrid**) - You need a git repository to work with (here we use **info_tfgrid**)
- Clone the hero mdbook repo on your local machine (i.e. the host) and note the path - Clone the hero mdbook repo on your local machine (i.e. the host) and note the path
@ -31,9 +31,15 @@ Once you've set Hero Docker, you can adjust the files at the host path in a code
Note that you will need to adjust the local path of the git repo and the docker path of the git repo. Note that you will need to adjust the local path of the git repo and the docker path of the git repo.
- On a terminal window, start Hero docker - On a terminal window, create the code repository on the local machine
``` ```
sudo docker run --name herodocker -d -v /local/machine/path/to/git/repo:/docker/path/to/git/repo/ ghcr.io/scottyeager/hero:latest 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
```
sudo docker run --net=host --name herodocker -d -v ~/code/git.ourworld.tf/tfgrid:~/code/git.ourworld.tf/tfgrid ghcr.io/scottyeager/hero:latest
``` ```
- In our case, the docker path to the repo is the following - In our case, the docker path to the repo is the following
``` ```
@ -43,24 +49,28 @@ Note that you will need to adjust the local path of the git repo and the docker
``` ```
sudo docker exec -it herodocker bash sudo docker exec -it herodocker bash
``` ```
- Change directory
```
cd ~/code/git.ourworld.tf/tfgrid/info_tfgrid
```
- Git configuration - Git configuration
- Set git lobally with a safe directory - Set git lobally with a safe directory
``` ```
git config --global --add safe.directory /root/code/git.ourworld.tf/tfgrid/info_tfgrid 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: - 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: - 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 - 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: - 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 mdbook serve -n 0.0.0.0
``` ```
- You should be able to view the rendered book at - You should be able to view the rendered book at

6
docs/mdbook_basics.md
View File

@ -80,7 +80,5 @@ choco install mdbook
- Update an mdbook on a GitHub repo - Update an mdbook on a GitHub repo
- https://manual.grid.tf/knowledge_base/collaboration/contribute.html - https://manual.grid.tf/knowledge_base/collaboration/contribute.html
- Deploy a Hero Mdbook on Docker - [Deploy a Hero Mdbook on Docker](./hero_mdbook_docker.md)
- https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/development/docs/hero_mdbook_docker.md - [Create a Hero Mdbook](./hero_create_mdbook.md)
- Create a Hero Mdbook
- https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/development/docs/hero_create_mdbook.md