Serve OCaml Compiler Manuals

[mtelvers]

• Include the precompiled html manuals from ocaml-web/html-compiler-manuals into the Dockerfile. The RUN line determines which branches exist and clones them all into local directories: /manual/4.14, /manual/5.0, etc; updating this is unnecessary when a new version is released.
• Updated the code to serve /manual and below from the local filesystem
• Added default name index.html when the directory is requested
• Updated the default manual link /manual to serve from these files rather than redirect to v2.ocaml.org

[shakthimaan]

We will need to add one for latest.

[sabine]

We don't need a redirect for latest, we need to serve this via Dream under /manual/latest. A redirect would mean that the URL in the browser would change to the specific version.

[cuihtlauac]

Using the following on the upstream https://github.com/ocaml-web:

git grep -ho 'href=\"https://[._a-z0-9/\-]*' | sort -u

I found the following hardcoded urls:

https://ocaml.org/
https://ocaml.org/releases/
https://ocaml.org/releases/4.13/ocaml-4.13-refman-html.tar.gz
https://ocaml.org/releases/4.13/ocaml-4.13-refman.info.tar.gz
https://ocaml.org/releases/4.13/ocaml-4.13-refman.pdf
https://ocaml.org/releases/4.13/ocaml-4.13-refman.txt
https://ocaml.org/releases/4.14/ocaml-4.14-refman-html.tar.gz
https://ocaml.org/releases/4.14/ocaml-4.14-refman.info.tar.gz
https://ocaml.org/releases/4.14/ocaml-4.14-refman.pdf
https://ocaml.org/releases/4.14/ocaml-4.14-refman.txt
https://ocaml.org/releases/5.0/ocaml-5.0-refman-html.tar.gz
https://ocaml.org/releases/5.0/ocaml-5.0-refman.info.tar.gz
https://ocaml.org/releases/5.0/ocaml-5.0-refman.pdf
https://ocaml.org/releases/5.0/ocaml-5.0-refman.txt
https://ocaml.org/releases/5.1/ocaml-5.1-refman-html.tar.gz
https://ocaml.org/releases/5.1/ocaml-5.1-refman.info.tar.gz
https://ocaml.org/releases/5.1/ocaml-5.1-refman.pdf
https://ocaml.org/releases/5.1/ocaml-5.1-refman.txt
https://ocaml.org/releases/5.2/ocaml-5.2-refman-html.tar.gz
https://ocaml.org/releases/5.2/ocaml-5.2-refman.info.tar.gz
https://ocaml.org/releases/5.2/ocaml-5.2-refman.pdf
https://ocaml.org/releases/5.2/ocaml-5.2-refman.txt
https://ocaml.org/releases/5.3/ocaml-5.3-refman-html.tar.gz
https://ocaml.org/releases/5.3/ocaml-5.3-refman.info.tar.gz
https://ocaml.org/releases/5.3/ocaml-5.3-refman.pdf
https://ocaml.org/releases/5.3/ocaml-5.3-refman.txt

All but the first two trampolines to v2. We should all turn them into relative links.

[cuihtlauac]

The changes I'm proposing to handle api urls are in this branch: https://github.com/ocaml/ocaml.org/tree/html-compiler-manuals-api

[sabine]

@cuihtlauac I don't see a reason why we should introduce a config variable OCAMLORG_MANUAL_PATH for the manual path. The rest looks useful on first glance, but haven't checked in detail.

[cuihtlauac]

@cuihtlauac I don't see a reason why we should introduce a config variable OCAMLORG_MANUAL_PATH for the manual path. The rest looks useful on first glance, but haven't checked in detail.

That allows developers to put their local copy of html-compiler-manual wherever they want/need (not only /).

[mtelvers]

I have added @cuihtlauac latest commit to this PR and included a commit to update line 50 of src/global/url.ml as the refactoring of these lines has made api_with_version the same as manual_with_version where they should be different:

-let api_with_version v = "/manual/" ^ minor v ^ "/index.html"
+let api_with_version v = "/manual/" ^ minor v ^ "/api/index.html"

@shakthimaan I note that search_icon.svg is missing from the api folder for all the versions of the manuals except for 4.12 and 4.13. I think it needs to be included.

[shakthimaan]

search_icon.svg is missing from the api folder

The search_icon.svg has been added to the respective api/ folders.

[sabine]

LGTM, on staging this seems to work fine

stale

[Octachron]

Thanks a lot for the hard work on integrating the reference manual !