This is Kanak. I am eagerly waiting for my outreachy results to work as an intern at OCaml. I am good at front-end development part and would love to contribute for OCaml website.
I have tried setting up the environment locally but since I am new to OCaml, can’t really find a way to start editing the HTML files. They are in markdown format and I am finding difficult to make changes in it. It would be really great, if i could get a help, so that I can start contributing as soon as possible.
Thanks beforehand !
The first step is to get the ocaml.org site building on your local machine. Have you done that?
Then you can start to modify the markdown files and see the effects in the generated HTML.
Hi, Thanks @JohnWhitington for replying. That was much needed.
Hi @Kanak, welcome to the OCaml community !
I’m part of the team running the Outreachy projects. I’ve just tagged you in an issue over on the ocaml.org repository. A few things:
- It looks like you’ve got the website code locally, great! I’m not sure you have built the site though. There will be an
ocaml.orgdirectory containing the built site after a successful build. This is the directory that will contain the
index.htmlyou can open to view the site locally in a browser.
- You are also using Windows – OCaml/opam support directly on Windows isn’t quite there yet (not to mention the many other commands that run to build the site). If it is possible, your best bet at building the site is using the Windows Subsystem for Linux (WSL). I think this guide should help you get setup. I must confess I know very little about the OCaml + Windows world so if anyone else has better advice please do chime in.
Thanks again for wanting to contribute to OCaml.
@patricoferris Thanks a ton. The guide that you have attached has near about solved my issues. I am now going to start working. Hurray !!