beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aviem...@apache.org
Subject [1/4] beam-site git commit: Improve committing website changes section in the contribution guide
Date Sun, 19 Mar 2017 03:59:20 GMT
Repository: beam-site
Updated Branches:
  refs/heads/asf-site f9b4c6e7a -> 41018ed60


Improve committing website changes section in the contribution guide


Project: http://git-wip-us.apache.org/repos/asf/beam-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/beam-site/commit/653218f8
Tree: http://git-wip-us.apache.org/repos/asf/beam-site/tree/653218f8
Diff: http://git-wip-us.apache.org/repos/asf/beam-site/diff/653218f8

Branch: refs/heads/asf-site
Commit: 653218f89c0a6b50283bf502538f8b131aa54ea1
Parents: f9b4c6e
Author: Ismaël Mejía <iemejia@apache.org>
Authored: Sun Mar 19 01:06:26 2017 +0100
Committer: Ismaël Mejía <iemejia@apache.org>
Committed: Sun Mar 19 01:08:50 2017 +0100

----------------------------------------------------------------------
 src/contribute/contribution-guide.md | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/beam-site/blob/653218f8/src/contribute/contribution-guide.md
----------------------------------------------------------------------
diff --git a/src/contribute/contribution-guide.md b/src/contribute/contribution-guide.md
index b2af352..c1617af 100644
--- a/src/contribute/contribution-guide.md
+++ b/src/contribute/contribution-guide.md
@@ -442,7 +442,7 @@ The general guidelines for cloning a repository can be adjusted to use
the `asf-
 
 While you are working on your pull request, you can test and develop live by running the
following command in the root folder of the website:
 
-	$ bundle exec jekyll serve
+	$ bundle exec jekyll serve --incremental
 
 Jekyll will start a webserver on port 4000. As you make changes to the content, Jekyll will
rebuild it automatically.
 
@@ -458,8 +458,15 @@ When you are ready, submit a pull request using the [Beam Site GitHub
mirror](ht
 
 During review, committers will patch in your PR, generate the static `content/`, and review
the changes.
 
-#### Committing website changes
+#### Committing website changes (committers only)
 
 Follow the same committer process as above, but using repository `apache/beam-site` and branch
`asf-site`.
 
-In addition, the committer is responsible for doing the final `jekyll build` to generate
the static content, so follow the instructions above to install `jekyll`.
+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`.
+
+This command generates the `content/` directory. The committer should add and commit the
content related to the PR.
+
+	$ git add content/<files related to the pr>
+	$ git commit -m "Regenerate website"
+
+Finally you should merge the changes into the `asf-site` branch and push them into the `apache`
repository.


Mime
View raw message