-
Notifications
You must be signed in to change notification settings - Fork 775
Description
What is the problem you're trying to solve
Developers today use Docker docs as the authoritative source of what functionality is and isn't supported. In relation to this project, Compose file reference (v3 and v2) are of particular interest. With Compose spec undergoing quite a few changes recently, these docs have unfortunately fallen behind (despite keeping the "go to" status). This makes the spec and occasional Compose tooling release notes the only way that users can find out about these enhancements. Anecdotally, I've encountered several situations now when Docker docs were used as "proof" that something isn't supported despite tooling actually supporting the new feature(s).
Describe the solution you'd like
Could we reuse the spec as user documentation for Compose file format?
Additional context
We could make sure that the spec renders well and get it published via GH Pages somewhere like docs.compose-spec.io
.
We might need to expand the spec to include some more implementation-oriented information like:
- What platforms does given attribute apply to?
- What implementations (and since what version) support this functionality?
For example, MDN web docs (in my opinion) do it really well for all things web.