Skip to content

Commit 504299a

Browse files
committed
docs: Improve the tutorial howto-deploy-learn-ocaml-statically
1 parent 9bc28a6 commit 504299a

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

docs/howto-deploy-learn-ocaml-statically.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,22 @@ How to deploy learn-ocaml statically
44
This section explains how to deploy a static version of learn-ocaml on
55
an HTTP server.
66

7-
## Using pre-built docker images
7+
## Compilation using pre-built docker images
88

99
You will just need to:
1010

1111
- install Docker Engine (<https://docs.docker.com/get-docker/>)
1212
- build the `www` folder by using the commands below
1313
- use an HTTP server to serve learn-ocaml statically.
1414

15+
Then use either of the following approaches:
16+
17+
### Manual docker commands
18+
1519
Assuming your exercise repository is in directory `$REPOSITORY` and
1620
you want to generate the website contents in directory `$TARGET/www`
1721
to serve it at `$URL` (the base URL **without trailing slash**), then
18-
you can run:
22+
run the following commands:
1923

2024
```bash
2125
# Remove old version
@@ -39,11 +43,18 @@ then you should first run:
3943
export URL=https://user-name.github.io/repo-name
4044
```
4145

46+
### An automatic deploy script
47+
48+
Just use the following script, committed within a GitHub Pages repo:
49+
50+
- <https://github.com/erikmd/learn-ocaml-meetup-demo/blob/master/deploy>
51+
4252
For a comprehensive example of one such deployment, you may take a
43-
look at the following repository:
44-
- <https://github.com/pfitaxel/pfitaxel-demo>
45-
- deployed to <https://pfitaxel.github.io/pfitaxel-demo>
46-
- thanks to this [`deploy` script](https://github.com/pfitaxel/pfitaxel-demo/blob/master/deploy).
53+
look at the following repos:
54+
55+
- <https://github.com/erikmd/learn-ocaml-meetup-demo-repository> (with extensive documentation in the [README.md](https://github.com/erikmd/learn-ocaml-meetup-demo-repository#readme))
56+
- <https://github.com/erikmd/learn-ocaml-meetup-demo> (separated repo containing a .gitignore and the `deploy` script)
57+
- <https://erikmd.github.io/learn-ocaml-meetup-demo/> (URL of the deployment)
4758

4859
## Manual compilation
4960

0 commit comments

Comments
 (0)