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

Want to help? Here are some tasks! #824

Open
2 of 28 tasks
Chris00 opened this issue Aug 22, 2016 · 8 comments
Open
2 of 28 tasks

Want to help? Here are some tasks! #824

Chris00 opened this issue Aug 22, 2016 · 8 comments

Comments

@Chris00
Copy link
Member

Chris00 commented Aug 22, 2016

Here are some tasks with some details about how to tackle them and possible references. Do not forget to add your name to the contributors page to showcase your efforts! In addition to the whole community being thankful, contributors demonstrating a strong commitment for several months will be offered commit rights to the repository.

Move the content of opam.ocaml.org to ocaml.org/opam/

  • Propose a design (mockups) for how the various menus would fit together.
  • Once the mockups are accepted, modify the opam.o.o maintenance scripts so they generate the proposed layout.
  • Merge the opam.o.o scripts with those of o.o to generate the opam content.
  • Adapt the infrastructure scripts — note they sync with deletion if 2 different builds are used.

Improve/restructure tutorials

Create thematic pages

For each of the topics below, list the various libraries that exists (should eventually be partly automated with opam tags), explain the strengths and weaknesses in order to help user to pick up the right one for him, for each of them show some code to get started,... This may be one way to incorporate content from awesome-ocaml. Inspiration for the topics: Python.

  • OCaml for the web (ocamlnet, ocsigen, cohttp, typed HTML, js_of_ocaml,...)
  • OCaml for science (lacaml, gls, sundialsml, root finding, lbfgs...)
  • ...

Improve the infrastructure

  • Make a tool to report which translations are out of date (based on the Git history). Use OCaml Git for that. Bonus points for showing the diff of the English version and opening an issue on Github.
  • Given some meetup groups, extract the dates of the meetings (from iCal links?) and display them on the website.
  • Separate the "Jobs" feeds (specific file alike planet_feeds.txt) and display them in another tab (next to News) on the front page and in another page in the planet (crosslinked with the planet).
  • Make a bot for IRC that would help with basic questions (eventually using machine learning) and help to collect stats.
  • Version control the infrastructure scripts — needs to be done in close collaboration with a member of OCaml.org team.
@AltGr
Copy link
Member

AltGr commented Aug 25, 2016

Move the content of opam.ocaml.org to ocaml.org/opam/

Note that this is generated by opam2web, and that there is some administration involved (README slightly out of date). Although merging the design and layout of the two sites is a good idea, I am uncertain about that move.

Note that the site also includes the not-quite-dead platform blog generated from this repo.

https://opam.ocaml.org/ is also used by opam as the repository where packages are fetched from, and I don't think that would be wise to change. Administration scripts mentionned above mix updates of the package repository and the website.

@Chris00
Copy link
Member Author

Chris00 commented Aug 25, 2016

@AltGr Thanks for the information. I am only talking about moving the web site part, not the data relevant to opam (and actually using opam.o.o to host backups of all packages, including their development repositories). Changing the domain name for a part of the site is not good IMHO—in particular, if you pin a tab with o.o, going to packages will open a new tab, which is confusing.

@amirmc
Copy link
Member

amirmc commented Aug 30, 2016

Move the content of opam.ocaml.org to ocaml.org/opam/

I think it's better to use something like ocaml.org/pkg/, or ocaml.org/packages, or similar. This doesn't tie it to the name of the tool and is better in the long term. The original wireframes I put together had examples of how this might work (there are screencasts in the blog post but the online version is no longer available). If they're still useful we can figure out how to update them.

example page
5_packages

@agarwal
Copy link
Member

agarwal commented Jun 6, 2017

I think it's better to use something like ocaml.org/pkg/, or ocaml.org/packages, or similar

On the other hand, opam has some brand recognition. Maybe good to go with ocaml.org/opam.

@dbuenzli
Copy link
Contributor

dbuenzli commented Jun 6, 2017

On the other hand, opam has some brand recognition. Maybe good to go with ocaml.org/opam.

Good uris are independent from the underlying technology.

@agarwal
Copy link
Member

agarwal commented Jun 7, 2017

Good uris are independent from the underlying technology.

I thought about it more, and yes I think you're right.

@Chris00 Chris00 changed the title [WIP] Want to help? Here are some tasks! Want to help? Here are some tasks! Jul 23, 2017
@zapashcanon
Copy link
Contributor

The install page (also the French one) should be updated. See also #801

I think it's OK now and with #992.

@Riddhima23
Copy link
Contributor

@Chris00 can I work on the issue of making a bot for IRC?

NebuPookins referenced this issue in NebuPookins/ocaml.org Jul 17, 2021
This is intended to address the issue mentioned in
ocaml/ocaml.org#824

This version of the tutorial now demonstrates how to use Set with
arbitrary types. It also provides a demonstration on how to reason
about the behavior of functions based on their type signatures.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants