Skip to content

Community meeting on docs.ocaml.org 2020 11 19

Jon Ludlam edited this page Nov 20, 2020 · 4 revisions

Community meeting on docs.ocaml.org 2020 11 19

Attending

  • @jonludlam
  • @lpw25
  • @avsm
  • @octachron
  • @AltGr
  • @Julow
  • @Drup
  • @rjbou
  • @dra27
  • @thomasblanc

Presentation

@jonludlam gave a short presentation to set the scene

Demo

A prototype of the suggested content of docs.ocaml.org is available here, showing multiple versions of packages, links correctly going to the right versions, 'forward' links from a dependency package to a package that depends upon it (conduit 2.1.0 linking to conduit-async), and parallel universes where packages are built against different sets of dependencies.

Discussion

Expected size of the artefacts: hundreds of gigs

Site is expected to be updated incrementally, however, is is very important that the site is 'reproducible' in the sense that in the unlikely scenario that we lost all of the artefacts, we would be able to reconstruct the site 'from scratch'.

  • will need to keep externally what solutions were found for each 'blessed' package

Important that the pages are stable - such that the anchors are always there, particularly from the 'packages' URLs, not so much the 'universes' pages.

Using 'Marshal' to write odoc files is fine because it's 'forward compatible' - writing from a

Phase 0: We want to, for all package versions, find a solution, install all the depopts possible, with the latest version of ocaml supported, and make a build graph. We then find the common overlapping subsets to minimise work.