Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

erikmd
Copy link
Member

@erikmd erikmd commented Dec 11, 2022

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)

@yurug
Copy link
Collaborator

yurug commented Dec 16, 2022

LGTM as the first cheap step to get good instructions.

@yurug
Copy link
Collaborator

yurug commented Dec 16, 2022

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

@yurug
Copy link
Collaborator

yurug commented Dec 16, 2022

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

@yurug
Copy link
Collaborator

yurug commented Dec 16, 2022

(I can turn the suggestions into issues!)

@erikmd
Copy link
Member Author

erikmd commented Nov 22, 2023

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)

@AltGr
Copy link
Collaborator

AltGr commented Nov 23, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants