Skip to content

Commit 952fedc

Browse files
committed
rearrange, shorten
1 parent a8f9b1a commit 952fedc

File tree

1 file changed

+29
-31
lines changed

1 file changed

+29
-31
lines changed

data/tool_pages/platform/2in_00_the_ocaml_infrastructure.md

Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ The OCaml ecosystem is supported by a [robust infrastructure built around OCurre
1616

1717
The OCaml infrastructure services can be grouped into three main categories: Community infrastructure services, services for individual projects, and infrastructure operation services. Here we present a brief overview of the major services from the first two categories.
1818

19-
### Community Infrastructure Services
19+
### Services for Individual Projects
2020

21-
These services power the broader OCaml ecosystem, supporting package repositories, documentation, and other essential community resources:
21+
These services used for your own projects to help with reproducible builds, testing, benchmarking, and continuous integration:
2222

2323
#### Docker Base Images
2424

@@ -29,35 +29,6 @@ This service builds the official `ocaml/opam` Docker images for various Linux di
2929

3030
**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).
3131

32-
#### Package Submission CI (opam-repo-ci)
33-
34-
**Service:** [opam-repo-ci](https://github.com/ocurrent/opam-repo-ci)
35-
**Website:** [opam.ci.ocaml.org](https://opam.ci.ocaml.org)
36-
37-
Tests package submissions to the opam repository. When you submit a pull request to opam-repository, this service verifies that your package builds correctly and also tests all dependent packages to ensure compatibility.
38-
39-
**Publishing a package to opam-repository:** After creating a GitHub release and opening an opam-repository PR with `dune-release`, monitor your opam-repository PR to ensure all tests pass.
40-
41-
#### Documentation CI
42-
43-
**Service:** [ocaml-docs-ci](https://github.com/ocurrent/ocaml-docs-ci)
44-
**Website:** [docs.ci.ocaml.org](https://docs.ci.ocaml.org)
45-
46-
Builds documentation for all packages in the opam repository, with correct cross-package linking. Generated documentation is published to the OCaml.org website.
47-
48-
**Package documentation on OCaml.org:** After publishing your package to opam-repository, the documentation will automatically be built and integrated with the [OCaml.org website's package area](https://ocaml.org/packages).
49-
50-
#### Package Health Check
51-
52-
**Service:** [opam-health-check](https://github.com/ocurrent/opam-health-check)
53-
**Website:** [check.ci.ocaml.org](https://check.ci.ocaml.org)
54-
55-
Regularly tests that all packages in the opam repository still build correctly. This service is used by OCaml compiler developers when preparing major changes like new OCaml compiler releases.
56-
57-
### Services for Individual Projects
58-
59-
These services can be enabled for your own GitHub repositories to help with testing, benchmarking, and continuous integration:
60-
6132
#### OCaml CI
6233

6334
**Service:** [ocaml-ci](https://github.com/ocurrent/ocaml-ci)
@@ -85,6 +56,33 @@ Tests OCaml projects against multicore OCaml versions - particularly useful if y
8556

8657
**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).
8758

59+
### Community Infrastructure Services
60+
61+
These services power the broader OCaml ecosystem, supporting package repositories, documentation, and other essential community resources:
62+
63+
#### Package Submission CI (opam-repo-ci)
64+
65+
**Service:** [opam-repo-ci](https://github.com/ocurrent/opam-repo-ci)
66+
**Website:** [opam.ci.ocaml.org](https://opam.ci.ocaml.org)
67+
68+
Tests package submissions to the opam repository. When you submit a pull request to opam-repository, this service verifies that your package builds correctly and also tests all dependent packages to ensure compatibility.
69+
70+
**Maintaining compatibility for packages in the opam-repository:** After publishing a package by creating a GitHub release and opening an opam-repository PR (e.g. by [using `dune-release`](/publishing-packages-w-dune)), monitor your opam-repository PR to ensure all tests pass.
71+
72+
#### Documentation CI
73+
74+
**Service:** [ocaml-docs-ci](https://github.com/ocurrent/ocaml-docs-ci)
75+
**Website:** [docs.ci.ocaml.org](https://docs.ci.ocaml.org)
76+
77+
Builds **documentation for all packages in the opam repository**, with correct cross-package linking. After publishing your package to opam-repository, the documentation will automatically be built and published to the [OCaml.org website's package area](https://ocaml.org/packages).
78+
79+
#### Package Health Check
80+
81+
**Service:** [opam-health-check](https://github.com/ocurrent/opam-health-check)
82+
**Website:** [check.ci.ocaml.org](https://check.ci.ocaml.org)
83+
84+
Regularly tests that all packages in the opam repository still build correctly. This service is used by OCaml compiler developers when preparing major changes like new OCaml compiler releases.
85+
8886
## Platform Support
8987

9088
The OCaml infrastructure supports building and testing on multiple platforms:

0 commit comments

Comments
 (0)