docs: state platform support (Linux/macOS/Windows) - #238
Merged
Conversation
Records the decision that Windows is a supported platform for datajoint, including file-protocol object stores and garbage collection, backed by CI. Adds a Platform support section describing what CI validates on each OS, mirroring the DB version-support-policy tone in database-backends.md. Depends on datajoint-python #1521 (path fix) + #1522 (Windows CI leg).
dimitri-yatsenko
added
the
documentation
MilagrosMarin
approved these changes
Jul 27, 2026
MilagrosMarin
left a comment
MilagrosMarin
left a comment
Collaborator
There was a problem hiding this comment.
LGTM — verified the three platform claims against CI config (Linux full suite via test.yaml:29 ubuntu-latest × py310/py314 × mysql 8.0/8.4; Windows unit suite matches #1522's unit-tests-windows job exactly; macOS "development platform" correctly reflects pixi platforms including osx-arm64 with no CI leg). Merge gate confirmed still active — #1520 closed, #1521/#1522 both open.
One nit: ## Platform support is sentence case, while every other ## in installation.md is Title Case (## Install DataJoint 2.0+, ## Verify Installation, ## Database Server, ## Requirements, ## Troubleshooting). Anchor resolves either way; just visible in the rendered TOC next to its siblings.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Records the decision to keep Windows a supported platform for DataJoint — including file-protocol object stores and garbage collection — backed by CI, rather than documenting it as unsupported. Consistent with the existing "supported == what we test in CI" framing (the DB version-support policy in
database-backends.md, from #1497).Change
Adds a Platform support section to
how-to/installation.md(plus a Requirements line), stating what CI validates on each OS:Wording is deliberately precise about what runs where so it doesn't overclaim (Windows runs the unit suite, not the DB-backed integration tests).
Related