Add Docker to run docsy user guide locally#1016
Merged
LisaFC merged 2 commits intogoogle:mainfrom Jun 13, 2022
Merged
Conversation
Add support to run the docsy website server locally inside a container. With support for both `docker` and `docker-compose`. The folder is mounted as a shared volume, allowing changes to be picked up by the container. The `node_modules` folder is kept in a volume, to avoid surfacing those files in the host folder. The documentation explains how to run the container as the host user, so you don't end up with files like `package.json` and `.hugo-build.lock` owned by root on the host os.
Collaborator
Author
|
Tested only on Linux, please test on Mac. |
Collaborator
|
Works fine on my Mac! |
fekete-robert
pushed a commit
to fekete-robert/docsy
that referenced
this pull request
Sep 13, 2022
Add support to run the docsy website server locally inside a container. With support for both `docker` and `docker-compose`. The folder is mounted as a shared volume, allowing changes to be picked up by the container. The `node_modules` folder is kept in a volume, to avoid surfacing those files in the host folder. The documentation explains how to run the container as the host user, so you don't end up with files like `package.json` and `.hugo-build.lock` owned by root on the host os. Co-authored-by: LisaFC <lcarey@google.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add support to run the docsy website server locally inside a container.
With support for both
dockeranddocker-compose.The folder is mounted as a shared volume, allowing changes to be picked up
by the container. The
node_modulesfolder is kept in a volume, toavoid surfacing those files in the host folder.
The documentation explains how to run the container as the host user, so
you don't end up with files like
package.jsonand.hugo-build.lockowned by root on the host os.
Docs preview