docs: include upstream docs in READMEs #792
Closed
Conversation
This file contains 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
|
Is this a good place to mention that I think it is a mistake to include the docker-compose configurations in the READMEs of the individual images? The thought here is that it is a maintenance headache, or liability, as I think they are likely to get out-of-date and cause confusion. I think it would be better if we simply linked to the Deploy configuration as reference in those places in the READMEs, and leave out the docker-compose samples in the image READMEs. Should I make this its own ticket or can we make it part of the scope of what is being done here? |
|
As we started to look a bit more into docs (e.g. #800) I would close this for now trusting that it will come up naturally again at some point soon. |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
Intention of this PR is the discussion about docs locations...