ctubbsii commented on code in PR #384: URL: https://github.com/apache/accumulo-website/pull/384#discussion_r1177177643
########## README.md: ########## @@ -108,6 +108,73 @@ HTML styled "just right". Jekyll will print a local URL where the site can be viewed (usually, [http://0.0.0.0:4000/](http://0.0.0.0:4000/)). +### Testing using Docker environment + +#### Build environment +A containerized development environment can be built using the local +Dockerfile. + +Run the build-images.sh script to generate the development environment and +associated images. + +```bash +./_scripts/build-images.sh +``` + +This action will produce two containers: `webdev` and `webdev-validator`. +The webdev container will execute a `jekyll serve` command with the +polling option enabled. + +This provides the ability to immediately review rendered content changes. + +```bash +docker run -d -v "$PWD":/site -p 4000:4000 webdev +``` + +Shell access can be obtained by overriding the default container command. + +This is useful for adding new gems, or modifying the Gemfile.lock for updating +existing dependencies. + +```bash +docker run -v "$PWD":/site -it webdev /bin/bash +``` + +Mounting the local directory as a volume is recommended to ensure that Gemfile and +Gemfile.lock stay updated with any dependency changes. Review Comment: Now that I'm understanding the Docker stuff better, I think we can streamline the container builds by just having one container (see earlier comment). I'll re-review the doc updates after that stuff is resolved. I actually still think the validation stuff should be done in a separate PR entirely. That would streamline this PR and we could get this merged in right away, doc updates included. With the validator stuff still up in the air (two containers vs. one container), I'm not sure what changes might still need to be made in the docs. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
