Added file/folder path mapping to readme #168
Merged
Conversation
This file contains hidden or 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
1 task
thespad
approved these changes
Apr 8, 2023
|
I am a bot, here are the test results for this PR: |
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.
Description:
This adds details of how BookStack files and folders within the container
/configvolume relate to those within a default BookStack installation.Benefits of this PR and context:
Related to #167.
The default file/folder names used within the mounted
/configfolder only match those within a BookStack installation by name, and they can be tricky to understand without understanding how these are linked within the container. Users can often need to know/use these files and directories when following BookStack documentation, for things like migrations from non-docker installs, or when switching between image storage options.How Has This Been Tested?
I have read-through my changes a couple of times, and ran them through the jenkins-builder process then checked the
README.mdfile output to ensure it was valid.Source / References: