You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by jk...@apache.org on 2017/08/10 19:59:33 UTC
[beam-site] branch asf-site updated (b6c68b3 -> 4878272)
This is an automated email from the ASF dual-hosted git repository.
jkff pushed a change to branch asf-site
in repository https://gitbox.apache.org/repos/asf/beam-site.git.
from b6c68b3 This closes #278: Add Apache Solr to the list of Built-In I/O Transforms
new 8d1305a A couple of fixes to website
new 9ed59a6 Regenerates website
new 4878272 This closes #286: A couple of fixes to the website
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.gitignore | 1 +
README.md | 16 +++++++++-------
Rakefile | 4 ++--
_config_test.yml | 4 +---
content/contribute/contribution-guide/index.html | 2 +-
src/contribute/contribution-guide.md | 2 +-
6 files changed, 15 insertions(+), 14 deletions(-)
--
To stop receiving notification emails like this one, please contact
['"commits@beam.apache.org" <co...@beam.apache.org>'].
[beam-site] 02/03: Regenerates website
Posted by jk...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
jkff pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 9ed59a60b78d1702a166f6f9efc1eae420059825
Author: Eugene Kirpichov <ki...@google.com>
AuthorDate: Thu Aug 10 12:59:00 2017 -0700
Regenerates website
---
content/contribute/contribution-guide/index.html | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/content/contribute/contribution-guide/index.html b/content/contribute/contribution-guide/index.html
index d7e89d2..5e941a6 100644
--- a/content/contribute/contribution-guide/index.html
+++ b/content/contribute/contribution-guide/index.html
@@ -780,7 +780,7 @@ $ git checkout -b <my-branch> origin/asf-site
<h4 id="committing-website-changes-committers-only">Committing website changes (committers only)</h4>
-<p>Follow the same committer process as above, but using repository <code class="highlighter-rouge">apache/beam-site</code> and branch <code class="highlighter-rouge">asf-site</code>.</p>
+<p>Follow the same committer process as above, but using repository <code class="highlighter-rouge">apache/beam-site</code> and branch <code class="highlighter-rouge">asf-site</code> and <code class="highlighter-rouge">https://gitbox.apache.org/repos/asf/beam-site.git</code> as the address for <code class="highlighter-rouge">git remote add apache</code>.</p>
<p>In addition, the committer is responsible for doing the final <code class="highlighter-rouge">bundle exec jekyll build</code> to generate the static content, so follow the instructions above to install <code class="highlighter-rouge">jekyll</code>.</p>
--
To stop receiving notification emails like this one, please contact
"commits@beam.apache.org" <co...@beam.apache.org>.
[beam-site] 01/03: A couple of fixes to website
Posted by jk...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
jkff pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 8d1305ae54df4125f0a05f322738230529a3c77d
Author: Eugene Kirpichov <ki...@google.com>
AuthorDate: Wed Aug 9 22:32:36 2017 -0700
A couple of fixes to website
* _config_test.yml was supposed to generate into the `.testcontent`
directory, per the original PR #66, but didn't. I fixed this.
* Fixed README.md to not say that `rake test` will regenerate content,
and rephrased it a bit.
* Added proper `git remote` address for the website in contribution
guide for committers.
---
.gitignore | 1 +
README.md | 16 +++++++++-------
Rakefile | 4 ++--
_config_test.yml | 4 +---
src/contribute/contribution-guide.md | 2 +-
5 files changed, 14 insertions(+), 13 deletions(-)
diff --git a/.gitignore b/.gitignore
index 8a530f9..818a730 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,7 @@ _site
.jekyll-metadata
vendor/
.bundle/
+.testcontent/
# Ignore IntelliJ files.
.idea/
diff --git a/README.md b/README.md
index d836dcb..70fe06c 100644
--- a/README.md
+++ b/README.md
@@ -26,12 +26,12 @@ Install [Ruby Gems](https://rubygems.org/pages/download), a package management f
Install [Bundler](http://bundler.io/v1.3/rationale.html), which we use to specify dependencies and ensure
a consistent environment for building the website, even across multiple developers on different machines:
- $ gem install bundler
+ $ gem install bundler
Use Bundler to download the versions of each dependency specified in the website's `Gemfile.lock`,
including [Jekyll](https://jekyllrb.com/):
- $ bundle install --deployment
+ $ bundle install --deployment
This will install a number of gems in a local `./vendor` directory.
@@ -39,7 +39,7 @@ This will install a number of gems in a local `./vendor` directory.
Launch Jekyll via Bundler in order to guarantee that the appropriate versions of the dependencies are used:
- $ bundle exec jekyll serve
+ $ bundle exec jekyll serve
Jekyll will start a webserver on port `4000`. As you make changes to the
content, Jekyll will rebuild it automatically. This is helpful if you want to see
@@ -49,12 +49,14 @@ In addition, check for dead links and the like by running the tests via:
$ bundle exec rake test
-Both of these commands will cause the `content/` directory to be generated. Merging autogenerated content can
-get tricky, so please leave this directory out of your commits and pull request by doing:
+Running Jekyll may cause the `content/` directory to be generated.
+Merging autogenerated content can get tricky, so regenerating content is
+responsibility of the committer doing the final merge of your PR, and
+your PR should not contain changes to that directory.
- $ git checkout -- content
+Before sending the PR for review, please run:
-The committer doing the final merge will generate the `content/` directory at that time.
+ $ git checkout -- content
### Running using Docker
diff --git a/Rakefile b/Rakefile
index 64b4358..b92022d 100644
--- a/Rakefile
+++ b/Rakefile
@@ -2,9 +2,9 @@ require 'fileutils'
require 'html-proofer'
task :test do
- FileUtils.rm_rf('./content')
+ FileUtils.rm_rf('./.testcontent')
sh "bundle exec jekyll build --config _config.yml,_config_test.yml"
- HTMLProofer.check_directory("./content", {
+ HTMLProofer.check_directory("./.testcontent", {
:allow_hash_href => true,
:check_html => true,
:file_ignore => [/javadoc/, /v2/, /pydoc/]
diff --git a/_config_test.yml b/_config_test.yml
index 607f568..0a2ca2d 100644
--- a/_config_test.yml
+++ b/_config_test.yml
@@ -1,5 +1,3 @@
# This config file contains options that override the default config for testing.
-url: ""
-baseurl: /subdir
-destination: content/subdir
+destination: .testcontent
diff --git a/src/contribute/contribution-guide.md b/src/contribute/contribution-guide.md
index 527d464..b37ece6 100644
--- a/src/contribute/contribution-guide.md
+++ b/src/contribute/contribution-guide.md
@@ -481,7 +481,7 @@ During review, committers will patch in your PR, generate the static `content/`,
#### Committing website changes (committers only)
-Follow the same committer process as above, but using repository `apache/beam-site` and branch `asf-site`.
+Follow the same committer process as above, but using repository `apache/beam-site` and branch `asf-site` and `https://gitbox.apache.org/repos/asf/beam-site.git` as the address for `git remote add apache`.
In addition, the committer is responsible for doing the final `bundle exec jekyll build` to generate the static content, so follow the instructions above to install `jekyll`.
--
To stop receiving notification emails like this one, please contact
"commits@beam.apache.org" <co...@beam.apache.org>.
[beam-site] 03/03: This closes #286: A couple of fixes to the
website
Posted by jk...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
jkff pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 487827272b195e703caca89ca84d24a18f004ad2
Merge: b6c68b3 9ed59a6
Author: Eugene Kirpichov <ki...@google.com>
AuthorDate: Thu Aug 10 12:59:17 2017 -0700
This closes #286: A couple of fixes to the website
.gitignore | 1 +
README.md | 16 +++++++++-------
Rakefile | 4 ++--
_config_test.yml | 4 +---
content/contribute/contribution-guide/index.html | 2 +-
src/contribute/contribution-guide.md | 2 +-
6 files changed, 15 insertions(+), 14 deletions(-)
--
To stop receiving notification emails like this one, please contact
"commits@beam.apache.org" <co...@beam.apache.org>.