You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -78,7 +78,8 @@ Here's how you can instantiate the development environment on your computer.
78
78
```shell
79
79
docker compose exec app bash
80
80
```
81
-
> You can think of this as "`ssh`-ing" into a Linux system. In this case, the Linux system is a Docker container running on your computer, and you are using something other than `ssh` to communicate with it.
81
+
> You can think of this as "`ssh`-ing" into a Linux system. In this case, the Linux system is a Docker container
82
+
> running on your computer, and you are using something other than `ssh` to communicate with it.
82
83
3. (Optional) Explore that container!
83
84
```shell
84
85
$ whoami
@@ -99,20 +100,29 @@ Here's how you can instantiate the development environment on your computer.
99
100
```shell
100
101
$ make gendoc
101
102
```
102
-
5. (Optional) Visit the MkDocs dev-server.
103
+
5. (Optional) Start the MkDocs dev-server.
104
+
```shell
105
+
$ poetry run mkdocs serve --dev-addr 0.0.0.0:8000
106
+
```
107
+
> The `0.0.0.0` part is necessary in order to be able to access the MkDocs dev-server
108
+
> [from your Docker host](https://github.com/mkdocs/mkdocs/issues/1239#issuecomment-354491734)
109
+
> (i.e. from outside the container). By default, the MkDocs dev-server only listens for requests coming from the
110
+
> [same computer](https://github.com/mkdocs/mkdocs/issues/2108) that is running the MkDocs dev-server
111
+
> (i.e. coming from inside the container).
112
+
6. (Optional) Visit the MkDocs dev-server.
103
113
- In your web browser, visit http://localhost:8000
104
114
> Note: If you customized `DOCS_PORT` earlier, use that port number instead of `8000` here.
105
-
6. Use the container running the `app` service, as your `nmdc-schema` development environment.
115
+
7. Use the container running the `app` service, as your `nmdc-schema` development environment.
106
116
```shell
107
117
$ poetry install
108
118
$ make squeaky-clean
109
119
$ poetry shell
110
120
# etc.
111
121
```
112
-
7. (Optional) Visit the Fuseki web server.
122
+
8. (Optional) Visit the Fuseki web server.
113
123
- In your web browser, visit http://localhost:3030
114
124
> Note: If you customized `FUSEKI_PORT` earlier, use that port number instead of `3030` here.
115
-
8. (Optional) Done working on this project (e.g. for the day)? Stop the containers.
125
+
9. (Optional) Done working on this project (e.g. for the day)? Stop the containers.
0 commit comments