You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kudu.apache.org by mp...@apache.org on 2018/02/07 01:15:12 UTC
kudu git commit: Update instructions for publishing changes to the
live site
Repository: kudu
Updated Branches:
refs/heads/master c1b9f1088 -> 1c8c0ad12
Update instructions for publishing changes to the live site
Change-Id: I7fc1a40d6deedf8eb1a9d8e6d13f803f6109c06b
Reviewed-on: http://gerrit.cloudera.org:8080/8059
Reviewed-by: Dan Burkert <da...@cloudera.com>
Tested-by: Mike Percy <mp...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/kudu/repo
Commit: http://git-wip-us.apache.org/repos/asf/kudu/commit/1c8c0ad1
Tree: http://git-wip-us.apache.org/repos/asf/kudu/tree/1c8c0ad1
Diff: http://git-wip-us.apache.org/repos/asf/kudu/diff/1c8c0ad1
Branch: refs/heads/master
Commit: 1c8c0ad12f52147f7238329f73218086916fef88
Parents: c1b9f10
Author: Mike Percy <mp...@apache.org>
Authored: Wed Sep 13 11:48:24 2017 -0700
Committer: Mike Percy <mp...@apache.org>
Committed: Wed Feb 7 01:15:01 2018 +0000
----------------------------------------------------------------------
README.adoc | 27 ++++++++++++++++++++++++++-
1 file changed, 26 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/kudu/blob/1c8c0ad1/README.adoc
----------------------------------------------------------------------
diff --git a/README.adoc b/README.adoc
index dda7ab1..e3be2d8 100644
--- a/README.adoc
+++ b/README.adoc
@@ -307,7 +307,7 @@ emitted to _build/docs_. This script requires `ruby` and `gem` to be installed
on the system path, and will attempt to install `asciidoctor` and other related
dependencies into `$HOME/.gems` using http://bundler.io/[bundler].
-=== Updating the documentation on the Kudu web site
+=== Updating the Kudu web site documentation
To update the documentation that is integrated into the Kudu web site,
including Javadoc documentation, you may run the following command:
@@ -328,6 +328,31 @@ You can proceed to commit the changes in the pages repository and send a code
review for your changes. In the future, this step may be automated whenever
changes are checked into the main Kudu repository.
+After making changes to the `gh-branch` branch, follow the instructions below
+when you want to deploy those changes to the live web site.
+
+=== Deploying changes to the Apache Kudu web site
+
+When the documentation is updated on the `gh-pages` branch, or when other web
+site files on that branch are updated, the following procedure can be used to
+deploy the changes to the official Apache Kudu web site. Committers have
+permissions to publish changes to the live site.
+
+[source,bash]
+----
+git checkout gh-pages
+git fetch origin
+git merge --ff-only origin/gh-pages
+./site_tool proof # Check for broken links (takes a long time to run)
+./site_tool publish # Generate the static HTML for the site.
+cd _publish && git push # Update the live web site.
+----
+
+NOTE: sometimes, due to glitches with the ASF gitpubsub system, a large commit,
+such as a change to the docs, will not get mirrored to the live site. Adding an
+empty commit and doing another git push tends to fix the problem. See the git
+log for examples of people doing this in the past.
+
== Improving build times
=== Caching build output