Add documentation to build the site with a docker container #148

sb2nov · 2017-02-08T10:11:10Z

Adding documentation in the Readme to allow building the site with a docker container. This solves some of the pain we face with ruby versions and gems being installed globally etc. So should make it easier for people to updated the docs.

Created a helper script for the two user facing functions, if you think this is reasonable I can also add it to the Contributor guide page.

R: @davorbonaci @aaltay PTAL

asfbot · 2017-02-08T10:13:09Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Test/224/
--none--

asfbot · 2017-02-08T10:14:14Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Test/225/
--none--

asfbot · 2017-02-08T10:15:36Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Stage/266/

Jenkins built the site at commit id 585db3c with Jekyll and staged it here. Happy reviewing.

Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again.

asfbot · 2017-02-08T10:20:12Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Stage/267/

Jenkins built the site at commit id be63d99 with Jekyll and staged it here. Happy reviewing.

Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again.

aaltay · 2017-02-08T16:35:46Z

Thank you. I like the idea. I will defer the review to @davorbonaci since I am not very familiar with jekyll.

davorbonaci

I think this is a great improvement @sb2nov, and it will certainly simply this for a ton of people!

Left a few minor comments about comments ;-)

davorbonaci · 2017-02-08T18:33:08Z

README.md

@@ -56,6 +56,16 @@ get tricky, so please leave this directory out of your commits and pull request

 The committer doing the final merge will generate the `content/` directory at that time.

+### Running using Docker
+
+**Note:** This is an optional method if you don't want to install gems locally and just use a container for development.


... use a container for running Jekyll. Mention it is platform-specific, i.e., you cannot use this on Windows.

It should work on windows as now docker natively supports it. https://docs.docker.com/docker-for-windows/

But you have a Bash script also? Running that on Windows is ~possible, but painful to the degree you'd probably want to install Ruby + gems instead. SGTM either way.

davorbonaci · 2017-02-08T18:35:46Z

README.md

+
+**Note:** This is an optional method if you don't want to install gems locally and just use a container for development.
+
+Make sure you have docker installed and we'll use the official jekyll image to build the site.


Please make sure you have Docker installed on your local machine.

docker -> Docker
jekyll -> Jekyll

Move the image piece in the serve paragraph.

davorbonaci · 2017-02-08T18:36:50Z

run_with_docker.sh

@@ -0,0 +1,35 @@
+#!/bin/bash


Comments at the top. What it does, how to use it, what it assumes, etc.?

davorbonaci · 2017-02-08T18:37:02Z

run_with_docker.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+serve() {


plenty of duplication between serve & test functions.

davorbonaci · 2017-02-08T18:37:36Z

run_with_docker.sh

+    --env="BUNDLE_CACHE=true" \
+    --env="BUNDLE_PATH=/srv/jekyll/vendor/bundle" \
+    jekyll/jekyll \
+    bash -c "bundle config build.nokogiri --use-system-libraries && bundle install && bundle exec jekyll server --force_polling --watch -H 0.0.0.0 -P 4000 --incremental"


serve vs. server here?

sb2nov · 2017-02-08T18:42:23Z

Thanks for the comments.

@davorbonaci Should I add it to the contributor guide or just leave it in the Readme ?

davorbonaci · 2017-02-08T19:56:16Z

I'd probably do it here only.

sb2nov · 2017-02-09T04:01:09Z

Thanks for the feedback, updated the PR.

asfbot · 2017-02-09T04:02:42Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Test/227/
--none--

asfbot · 2017-02-09T04:06:41Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Test/228/
--none--

asfbot · 2017-02-09T04:08:17Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Stage/269/

Jenkins built the site at commit id 247c80e with Jekyll and staged it here. Happy reviewing.

Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again.

asfbot · 2017-02-09T04:13:21Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Stage/270/

Jenkins built the site at commit id f1b10b2 with Jekyll and staged it here. Happy reviewing.

Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again.

davorbonaci

Beautiful!

davorbonaci · 2017-02-09T05:09:01Z

README.md

+
+Prerequisites: Make sure you have Docker installed on your machine.
+
+For building the site use the command `./run_with_docker.sh server`. This will start the webserver inside a Docker container and port forward to your local machine at `localhost:4000`. We'll use the official Jekyll image to build the site.


For building the site*,* use

davorbonaci · 2017-02-09T05:10:25Z

README.md

+
+For building the site use the command `./run_with_docker.sh server`. This will start the webserver inside a Docker container and port forward to your local machine at `localhost:4000`. We'll use the official Jekyll image to build the site.
+
+For running the tests to verify all links use `./run_with_docker.sh test`.


For running the website tests, use...

Remove "to verify all links". Tests currently just do that, but soon enough they'll be doing more stuff. So, just abstract away what the tests does.

Makes sense, updated.

davorbonaci · 2017-02-09T05:10:40Z

run_with_docker.sh

+# This script will run Jekyll inside Docker to build the site.
+#
+# Use "./run_with_docker.sh server" to build the site at localhost:4000.
+# Use "./run_with_docker.sh tesst" to test for any broken links.


Sorry, thanks for catching this. Should have been more careful.

asfbot · 2017-02-09T05:15:25Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Test/229/
--none--

asfbot · 2017-02-09T05:19:22Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Stage/271/

Jenkins built the site at commit id de3cc57 with Jekyll and staged it here. Happy reviewing.

Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again.

sb2nov force-pushed the add_docker_runtime branch from 585db3c to be63d99 Compare February 8, 2017 10:12

davorbonaci requested changes Feb 8, 2017

View reviewed changes

sb2nov force-pushed the add_docker_runtime branch 2 times, most recently from 247c80e to f1b10b2 Compare February 9, 2017 04:00

davorbonaci approved these changes Feb 9, 2017

View reviewed changes

Add documentation to build the site with a jekyll container

de3cc57

sb2nov force-pushed the add_docker_runtime branch from f1b10b2 to de3cc57 Compare February 9, 2017 05:13

asfgit closed this in c9a64d3 Feb 9, 2017

sb2nov deleted the add_docker_runtime branch February 9, 2017 05:19

robertwb pushed a commit to robertwb/incubator-beam that referenced this pull request Jun 5, 2018

This closes apache/beam-site#148

efcad3b

robertwb pushed a commit to robertwb/incubator-beam that referenced this pull request Jun 5, 2018

This closes apache/beam-site#148

0a76fe5

melap pushed a commit to apache/beam that referenced this pull request Jun 20, 2018

This closes apache/beam-site#148

e66a2c4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation to build the site with a docker container #148

Add documentation to build the site with a docker container #148

sb2nov commented Feb 8, 2017

asfbot commented Feb 8, 2017

asfbot commented Feb 8, 2017

asfbot commented Feb 8, 2017

asfbot commented Feb 8, 2017

aaltay commented Feb 8, 2017

davorbonaci left a comment

davorbonaci Feb 8, 2017

sb2nov Feb 8, 2017

davorbonaci Feb 8, 2017

sb2nov Feb 9, 2017

davorbonaci Feb 8, 2017

sb2nov Feb 9, 2017

davorbonaci Feb 8, 2017

sb2nov Feb 9, 2017

davorbonaci Feb 8, 2017

sb2nov Feb 9, 2017

davorbonaci Feb 8, 2017

sb2nov Feb 9, 2017

sb2nov commented Feb 8, 2017

davorbonaci commented Feb 8, 2017

sb2nov commented Feb 9, 2017

asfbot commented Feb 9, 2017

asfbot commented Feb 9, 2017

asfbot commented Feb 9, 2017

asfbot commented Feb 9, 2017

davorbonaci left a comment

davorbonaci Feb 9, 2017

sb2nov Feb 9, 2017

davorbonaci Feb 9, 2017

sb2nov Feb 9, 2017

davorbonaci Feb 9, 2017

sb2nov Feb 9, 2017

asfbot commented Feb 9, 2017

asfbot commented Feb 9, 2017


		Note: This is an optional method if you don't want to install gems locally and just use a container for development.

		Make sure you have docker installed and we'll use the official jekyll image to build the site.


		Prerequisites: Make sure you have Docker installed on your machine.

		For building the site use the command `./run_with_docker.sh server`. This will start the webserver inside a Docker container and port forward to your local machine at `localhost:4000`. We'll use the official Jekyll image to build the site.


		For building the site use the command `./run_with_docker.sh server`. This will start the webserver inside a Docker container and port forward to your local machine at `localhost:4000`. We'll use the official Jekyll image to build the site.

		For running the tests to verify all links use `./run_with_docker.sh test`.

		@@ -0,0 +1,35 @@
		#!/bin/bash

		serve() {

Add documentation to build the site with a docker container #148

Add documentation to build the site with a docker container #148

Conversation

sb2nov commented Feb 8, 2017

asfbot commented Feb 8, 2017

asfbot commented Feb 8, 2017

asfbot commented Feb 8, 2017

asfbot commented Feb 8, 2017

aaltay commented Feb 8, 2017

davorbonaci left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sb2nov commented Feb 8, 2017

davorbonaci commented Feb 8, 2017

sb2nov commented Feb 9, 2017

asfbot commented Feb 9, 2017

asfbot commented Feb 9, 2017

asfbot commented Feb 9, 2017

asfbot commented Feb 9, 2017

davorbonaci left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asfbot commented Feb 9, 2017

asfbot commented Feb 9, 2017