updated docker docs hero
This commit is contained in:
parent
f5db05da35
commit
54876636a9
@ -13,15 +13,19 @@
|
|||||||
|
|
||||||
We give the basic steps to use Hero on Docker to run and create mdBooks.
|
We give the basic steps to use Hero on Docker to run and create mdBooks.
|
||||||
|
|
||||||
|
You can then use a code editor, e.g. VSCodium, to change the files locally and use Hero docker to build and serve the book.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- Docker engine should be installed and running
|
- Docker engine should be installed and running
|
||||||
- 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 and note the path
|
- Clone the hero mdbook repo on your local machine (i.e. the host) and note the path
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
In this setup, we will have two temrinal windows running. One window running the **docker run** command and the other running the **docker exec** command. Steps are shown in details.
|
We show the steps to use Hero with Docker.
|
||||||
|
|
||||||
|
Once you've set Hero Docker, you can adjust the files at the host path in a code editor and use the docker container to build and serve the book with Hero.
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
@ -42,11 +46,6 @@ Note that you will need to adjust the local path of the git repo and the docker
|
|||||||
```
|
```
|
||||||
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
|
||||||
```
|
```
|
||||||
- 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**
|
- You can now use Hero normally, e.g. with **projectinca**
|
||||||
- With a URL:
|
- With a URL:
|
||||||
```
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user