(docs) add a page about the OCaml Infrastructure #3107
Conversation
sabine
force-pushed
the
infrastructure_page
branch
from
aca3dab to
952fedc
Compare
|
|
||
| ### Services for Individual Projects | ||
|
|
||
| These services used for your own projects to help with reproducible builds, testing, benchmarking, and continuous integration: |
There was a problem hiding this comment.
| These services used for your own projects to help with reproducible builds, testing, benchmarking, and continuous integration: | |
| These services can be used for your own projects to help with reproducible builds, testing, benchmarking, and continuous integration: |
| **Service:** [docker-base-images](https://github.com/ocurrent/docker-base-images) | ||
|
|
||
| **Website:** [images.ci.ocaml.org](https://images.ci.ocaml.org) |
There was a problem hiding this comment.
I wonder if this should be something like
| **Service:** [docker-base-images](https://github.com/ocurrent/docker-base-images) | |
| **Website:** [images.ci.ocaml.org](https://images.ci.ocaml.org) | |
| **Source:** [docker-base-images](https://github.com/ocurrent/docker-base-images) | |
| **Service:** [images.ci.ocaml.org](https://images.ci.ocaml.org) |
or maybe "Repo"/"Service" or somtehing? I'm thinking this because the "Website" is actually a view into the running service, but the github repo is just the source code from which the service is deployed.
|
|
||
| **Website:** [images.ci.ocaml.org](https://images.ci.ocaml.org) | ||
|
|
||
| This service builds the official `ocaml/opam` Docker images for various Linux distributions, OCaml versions, compiler flags, and architectures (including x86, ARM, PowerPC, s390x, and RISC-V). These images provide a consistent environment for development and testing and are used by many other CI services. |
There was a problem hiding this comment.
Since I think it is nice to link the first time something is mentioned:
| This service builds the official `ocaml/opam` Docker images for various Linux distributions, OCaml versions, compiler flags, and architectures (including x86, ARM, PowerPC, s390x, and RISC-V). These images provide a consistent environment for development and testing and are used by many other CI services. | |
| This service builds the official [`ocaml/opam`](https://hub.docker.com/r/ocaml/opam) Docker images for various Linux distributions, OCaml versions, compiler flags, and architectures (including x86, ARM, PowerPC, s390x, and RISC-V). These images provide a consistent environment for development and testing and are used by many other CI services. |
|
|
||
| This service builds the official `ocaml/opam` Docker images for various Linux distributions, OCaml versions, compiler flags, and architectures (including x86, ARM, PowerPC, s390x, and RISC-V). These images provide a consistent environment for development and testing and are used by many other CI services. | ||
|
|
||
| **Using the pre-built OCaml Docker images:** You can view the available [pre-built Docker images for various OCaml configurations at DockerHub](https://hub.docker.com/r/ocaml/opam). |
There was a problem hiding this comment.
If we are linking the main docker hub page when first mentioned above, maybe it is then helpful to have this go to
| **Using the pre-built OCaml Docker images:** You can view the available [pre-built Docker images for various OCaml configurations at DockerHub](https://hub.docker.com/r/ocaml/opam). | |
| **Using the pre-built OCaml Docker images:** You can view the available [pre-built Docker images for various OCaml configurations at DockerHub](https://hub.docker.com/r/ocaml/opam/tags). |
Which presents people with the list of platforms that is the topic here?
| #### Continuous Benchmarking | ||
|
|
||
| **Service:** [current-bench](https://github.com/ocurrent/current-bench) | ||
|
|
||
| **Website:** [bench.ci.dev](https://bench.ci.dev) | ||
|
|
||
| Provides continuous benchmarking for OCaml projects to track performance across different commits and branches. | ||
|
|
||
| **How to enable current-bench on your GitHub project:** Check out the [current-bench User Manual](https://github.com/ocurrent/current-bench/blob/main/doc/user_manual.md). |
There was a problem hiding this comment.
I don't know that we should be listing and advertising this. The readme of current-bench says:
current-bench doesn't accept enrollment for community projects at this time, but feel free to open an issue to tell us you're interested.
At least, this is not actually something that we are inviting people to use in their personal projects?
| #### OCaml-Multicore-CI | ||
|
|
||
| **Service:** [ocaml-multicore-ci](https://github.com/ocurrent/ocaml-multicore-ci) | ||
|
|
||
| **Website:** [ocaml-multicore.ci.dev](https://ocaml-multicore.ci.dev) | ||
|
|
||
| Tests OCaml projects against multicore OCaml versions - particularly useful if you want to ensure your code is compatible with OCaml 5.x. | ||
|
|
||
| **How to enable OCaml-Multicore-CI on your GitHub project:** Check out the [OCaml-Multicore-CI README on GitHub](https://github.com/ocurrent/ocaml-multicore-ci). |
There was a problem hiding this comment.
I have not been involved with this, but I don't know what its use case is beyond ocaml-ci now that 5 is out for some time and we are running ocaml 5.x in ocaml-ci.
It doesn't seem to me that this is a service we want people thinking is maintained and available for their use on individual projects.
No description provided.