learn-ocaml icon indicating copy to clipboard operation
learn-ocaml copied to clipboard

docs: Improve the tutorial howto-deploy-learn-ocaml-statically

Open erikmd opened this issue 2 years ago • 6 comments
trafficstars

Description

Change the repository example mentioned in:

https://ocaml-sf.org/learn-ocaml/howto-deploy-learn-ocaml-statically

to link to the longer documentation available in:

https://github.com/erikmd/learn-ocaml-meetup-demo-repository#readme

Checklist

Note to maintainers

  • Read this wiki page
  • Make sure the PR has a milestone
  • Assign yourself before merging
  • We can squash-merge 1-commit PRs (use a header with a conventional-commit type, add a footer with Fix #… if need be)

erikmd avatar Dec 11 '22 21:12 erikmd

LGTM as the first cheap step to get good instructions.

yurug avatar Dec 16 '22 12:12 yurug

Suggestion 1: At some point, we should inline the contents in the main repository to avoid spreading knowledge in several places.

yurug avatar Dec 16 '22 13:12 yurug

Suggestion 2: The commands are mentioning a specific version of learnocaml.

yurug avatar Dec 16 '22 13:12 yurug

(I can turn the suggestions into issues!)

yurug avatar Dec 16 '22 13:12 yurug

FYI @AltGr I'm reworking this PR (sorry for the delay) to better document how-to download the static build artifacts from any learn-ocaml commit.

If you don't object, I will integrate this picture in the Markdown documentation:

2023-11_Screenshot_learn-ocaml_commit_HEAD

(Stay tuned)

erikmd avatar Nov 22 '23 01:11 erikmd

Yeah Github is terrible in that regard... making artifacts easily available should be a no-brainer. Even with the screenshot I am ​not sure this is a viable solution because it requires you to have an account and be logged ​into Github (and consequently doesn't work with curl, etc.)

The workaround I could find, which I used here​ is to rely on github-pages, which provides a publicly accessible space. ​ Results can be seen at https://catalalang.github.io/catala/

Sorry, I should have pointed out this possibility earlier but for some reason thought we already had a solution for this.

AltGr avatar Nov 23 '23 13:11 AltGr