ctubbsii commented on code in PR #384: URL: https://github.com/apache/accumulo-website/pull/384#discussion_r1178125321
########## README.md: ########## @@ -108,6 +108,50 @@ 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 Review Comment: We can get rid of this section header, since we don't need to go that deep and there's only one section here now. We can revisit later, if needed. ```suggestion ``` ########## README.md: ########## @@ -108,6 +108,50 @@ 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. Review Comment: ```suggestion A containerized development environment can be built using the local Dockerfile. You can build it with the following command: ``` ########## README.md: ########## @@ -108,6 +108,50 @@ 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 +docker build -t webdev . +``` + +This action will produce a `webdev` container which will execute a +`jekyll serve` command with the polling option enabled. + +The webdev container does not store any site content inside of it. +For rendering to function, the local directory must be mounted inside +the container in a read/write configuration. + +This mounting is accomplished with the volume `-v` flag in the +following `docker run` command. Review Comment: When you run a container using the webdev image, your current working directory will be mounted, so that any changes made by the build inside the container will be reflected in your local workspace. This is done with the `-v` flag. To run the container, execute the following command: ########## README.md: ########## @@ -108,6 +108,50 @@ 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 +docker build -t webdev . +``` + +This action will produce a `webdev` container which will execute a +`jekyll serve` command with the polling option enabled. Review Comment: ```suggestion This action will produce a `webdev` image, with all the website's build prerequisites preinstalled. When a container is run from this image, it will perform a `jekyll serve` command with the polling option enabled, so that changes you make locally will be immediately reflected. ``` ########## README.md: ########## @@ -108,6 +108,50 @@ 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 +docker build -t webdev . +``` + +This action will produce a `webdev` container which will execute a +`jekyll serve` command with the polling option enabled. + +The webdev container does not store any site content inside of it. +For rendering to function, the local directory must be mounted inside +the container in a read/write configuration. + +This mounting is accomplished with the volume `-v` flag in the +following `docker run` command. + +```bash +docker run -d -v "$PWD":/mnt/workdir -p 4000:4000 webdev +``` + +This provides the ability to immediately review rendered content changes at +[http://127.0.0.1:4000/](http://127.0.0.1:4000/). + Review Comment: ```suggestion While this container is running, you will be able to review the rendered website in your local browser at [http://127.0.0.1:4000/](http://127.0.0.1:4000/). ``` -- 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]
