-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Refactor docker locations and README. #3253
Conversation
This addresses #3224
Hmm. Do I need a |
docker/README.md
Outdated
### Using docker-compose (easier) | ||
|
||
This image is designed to run either with an automatically generated configuration | ||
file or with a custom configuration that requires manual edition. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
edition?
docker/README.md
Outdated
This image is designed to run either with an automatically generated configuration | ||
file or with a custom configuration that requires manual edition. | ||
|
||
An easy way to make use of this image is via docker-compose, see the (https://github.com/matrix-org/synapse/tree/develop/contrib/docker)[contrib] section of the synapse project for examples. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can't use a comma to join independent clauses. s/,/./
Turns out that I'm not really sure why some things are excluded that way, and others via MANIFEST.in. I think I prefer the latter. I think you want |
@michaelkaye I believe this was superseded by #3644 - correct? |
this seems to be dead. |
This addresses #3224 - we need to have the README in the same directory as the Dockerfile, but we currently have the main synapse readme in the root folder.
Moving the Dockerfile into the subdirectory will make it slightly harder (add
-f docker/Dockerfile
to the build command) but will make the updating of the readme on docker hub much simpler.Also, by moving parts out of contrib that don't belong there, we can make it clearer which parts of the packaging we're supporting directly (and hopefully incorporate more contrib code, which depends on the image).