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

dev_docs #154

Merged
mik-tf merged 2 commits from dev_docs into development 2024-10-23 03:51:36 +00:00
Conversation 0 Commits 2 Files Changed 2 +13 -7
2 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 800022e588 - Show all commits

14
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
- [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
- 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
@ -31,9 +31,13 @@ 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.
- 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
```
- 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
```
@ -43,6 +47,10 @@ Note that you will need to adjust the local path of the git repo and the docker
```
sudo docker exec -it herodocker bash
```
- Change directory
```
cd ~/code/git.ourworld.tf/tfgrid
```
- Git configuration
- Set git lobally with a safe directory
```

6
docs/mdbook_basics.md
View File

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