Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Refactor docker locations and README. #3253

Closed
wants to merge 7 commits into from

Conversation

michaelkaye
Copy link
Contributor

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).

@michaelkaye
Copy link
Contributor Author

Hmm. Do I need a recursive-exclude docker here to make travis-ci happy? I'm slightly confused why contrib/docker doesn't raise the same error.

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.
Copy link
Member

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.
Copy link
Member

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/,/./

@richvdh
Copy link
Member

richvdh commented May 24, 2018

Turns out that contrib/* is explicitly excluded from check-manifest by setup.cfg.

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 prune docker there.

@richvdh richvdh assigned michaelkaye and unassigned richvdh May 24, 2018
@turt2live
Copy link
Member

@michaelkaye I believe this was superseded by #3644 - correct?

@dali99
Copy link

dali99 commented Sep 7, 2018

From #3644

This is based on the changes in #3253 but old branch is old, so tidying it up and re-submitting as a new, clean PR.

@richvdh
Copy link
Member

richvdh commented Sep 20, 2018

this seems to be dead.

@richvdh richvdh closed this Sep 20, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants