Remove instructions from readme about customizing files #487
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
What
Remove instructions from readme about customizing files on persistent volumes.
Why
The instructions currently set someone up to fail because they describe a use case that is misaligned with the goals of the image, and misaligned with the actual maintenance that takes place on this image.
This image is for development and testing, both in the local form, and in the form of being able to deploy the image to simple PaaS environments in a short lived form. (Note that helm charts and other methods for installing and hosting the Stellar services exist for longer form and more complex environments.)
The organization of the files is particularly brittle. When maintaining the image for its primary purpose it is common that we need to change the organization of the files in ways that make the image incompatible with users who have customized the files.
Given that we've broken how those files work in the past and nobody has spoken up there's some signal, or lack of signal, that suggests very few people are actually customizing the files.
Nothing about this change prevents someone from customizing the files. The files are still stored in the location that becomes persistent when used in persistent mode.
This change serves to stop promoting it as a recommended way to use the image.
The change also adds a note clarifying how there is no compatibility guarantee on the configuration files.
Close #478