mirror of
https://github.com/tiennm99/composes.git
synced 2026-10-04 04:12:56 +00:00
docs: record compose.yml naming convention for new services
New services take the current Compose spec filename. Existing docker-compose.yml files stay as they are so unrelated changes do not carry a rename.
This commit is contained in:
1 parent
41fe522c0d
commit
2de7bb68ab
1 file changed
+7
@@ -4,6 +4,13 @@ Personal docker compose collection. One directory per service, each holding
|
||||
`compose.yml`, its own `README.md`, a committed `.env.example`, and a
|
||||
gitignored `.env`.
|
||||
|
||||
## File naming
|
||||
|
||||
New services use `compose.yml` — the current Compose spec name, and the
|
||||
shorter one. Existing services that still use `docker-compose.yml` stay as
|
||||
they are; do not rename them, not even while touching the file for something
|
||||
else.
|
||||
|
||||
The root `README.md` is an index only — it covers the shared conventions and
|
||||
links out to each service. Per-service detail (variables, ports, storage)
|
||||
belongs in that service's README, not the root one. Adding a service means
|
||||
|
||||
Reference in new issue
Block a user