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

Move voodoo to OCaml.org or ocaml-docs-ci #84

Open
tmattio opened this issue Jan 24, 2023 · 4 comments
Open

Move voodoo to OCaml.org or ocaml-docs-ci #84

tmattio opened this issue Jan 24, 2023 · 4 comments
Assignees

Comments

@tmattio
Copy link
Contributor

tmattio commented Jan 24, 2023

OCaml.org is split into three repositories:

  • OCaml.org
  • Voodoo
  • ocaml-docs-ci

This makes maintenance more complicated than it needs to be and increases the entry bar for new contributors for seemingly no added value. While the docs pipeline should probably remain separated from OCaml.org, we can merge voodoo with one of the other repositories. I'm in favour of moving it to the ocaml-docs-ci repository as it is essentially defining the behaviour of the pipeline, so it seems like a better separation of concerns.

@sabine
Copy link
Contributor

sabine commented Jan 24, 2023

IMO, the most confusing thing about voodoo as a newcomer is the name. It doesn't give any hints on what this actually does. So I would be in favor of renaming voodoo to something more descriptive, e.g. like package-docs-gen

We have here:

  • ocaml.org: the webserver. It looks up data, then renders HTML pages. In ocaml.org's repository also lives the data-generator ood-gen which generates HTML for various data items on ocaml.org.
  • voodoo: the package documentation generator. Given a package, it generates data in a format that ocaml.org consumes.
  • ocaml-docs-ci: the system that creates tasks that run the package documentation generator. Since the data is dynamically changing all the time, as people publish new packages and versions, it makes sense that this is separate from ocaml.org, so that the substantial complexity of building package documentation in the background is insulated from ocaml.org.

I would argue that changes to voodoo and ocaml.org often go hand-in-hand, so I think that your earlier idea of co-locating voodoo within ocaml.org's repository would be fine. Newcomers to ocaml.org development need to easily find where the package documentation data is generated, when they need to make changes to the package documentation webpages. They don't need to see all the complexities of the pipeline for that.

However, to move voodoo somewhere else, we first need a solid plan for how to handle upgrades of voodoo.

@tmattio
Copy link
Contributor Author

tmattio commented Jan 24, 2023

Moving to either OCaml.org or ocaml-docs-ci would simplify the whole setup, so I'm fine with anything you prefer!

@sabine
Copy link
Contributor

sabine commented Jan 26, 2023

Move into ocaml.org and expose voodoo via Dockerfile with opam-repository pin sounds sane to me.

@shonfeder
Copy link
Contributor

This relocation will help us with our centralization efforts. I've provisionally re-assigned this to @cuihtlauac, thinking that his experience with ocaml.org may provide useful context. But we should talk about how to move forward here and whether it is a good fit synchronously.

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

No branches or pull requests

4 participants