You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@edgent.apache.org by wc...@apache.org on 2016/03/17 04:34:37 UTC
[1/3] incubator-quarks-website git commit: [QUARKS-28] Update
README.md and add build.sh for publishing web site
Repository: incubator-quarks-website
Updated Branches:
refs/heads/master 7cc16a759 -> c08e83f1d
[QUARKS-28] Update README.md and add build.sh for publishing web site
Project: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/commit/8d746789
Tree: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/tree/8d746789
Diff: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/diff/8d746789
Branch: refs/heads/master
Commit: 8d74678972624c4707c0fe3b42a37713df302c9f
Parents: 7cc16a7
Author: Katherine Marsden <km...@apache.org>
Authored: Tue Mar 15 15:58:42 2016 -0700
Committer: Katherine Marsden <km...@apache.org>
Committed: Tue Mar 15 15:58:42 2016 -0700
----------------------------------------------------------------------
README.md | 85 +++++++++++++++++++---------------------------------------
build.sh | 13 +++++++++
2 files changed, 41 insertions(+), 57 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/8d746789/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 32c6a9d..2f4549a 100644
--- a/README.md
+++ b/README.md
@@ -17,69 +17,40 @@ limitations under the License.
{% endcomment %}
-->
-# Apache Website Template
+# Quarks web site
-This project contains a template web site that aims to follow all the various required
-Apache Website Policies.
+This procedure was borrowed in part from the apex site. (https://git-wip-us.apache.org/repos/asf?p=incubator-apex-site.git) except we use jekyll.
-This template was generated using [Jekyll](https://jekyllrb.com/).
+ How it works
+ ------------
+ The master branch of this repo contains the source files that are used to generate the HTML that ultimately gets pushed to the incubator site.
+The `asf-site` branch is where the actual generated files are stored. Note that this branch must contain exactly one folder called `content`,
+ and so has been checked out as an orphan branch with its own commit history apart from the master branch. See the *Contributing* section below.
+
+Through a [gitpubsub](http://www.apache.org/dev/gitpubsub.html) mechanism on the apache.org server,
+files are taken from the `asf-site` branch and pushed to the live server.
-To use it, copy the `site` directory into your project. You must also
-include licensing information from the `LICENSE` and `NOTICE` files in
-your own project.
+Contributing
+------------
+If you would like to make a change to the site:
+
+ 1. Fork the [github mirror](https://github.com/apache/incubator-quarks-website)
+ 2. Create a new branch from `master`
+ 3. Add commit(s) to your branch
+ 4. Test your changes locally
+ 5. Open a pull request on the github mirror
+ 6. A committer will merge your changes if all is good
-# How to deploy your project's web site
+If you are a committer, do the following:
+
+ 1. Update the master branch with your (or a Pull Request's) change.
+ 2. Push updated master to the asf remote master (https://git-wip-us.apache.org/repos/asf/incubator-quarks-site.git)
+ 3. Run `build.sh` from the master branch directory (requires jekyll). This will:
+ - checks out and updates the `asf-site` branch with a new commit of the build from the current branch
+
+ 4. At this point, you should be on the `asf-site` branch. Simply push this branch to the asf remote and the site will automatically be updated within seconds.
-(In the following instructions we assume that your project is called
-'Apache Foo'; search and replace with your actual project name.)
-## Setup
-```
-1. cd site
-2. svn co https://svn.apache.org/repos/asf/foo/site target
-3. sudo apt-get install rubygems ruby2.1-dev zlib1g-dev
-4. sudo gem install bundler github-pages jekyll
-5. bundle install
-```
-## Add javadoc
-If your project supports javadoc, you can copy the generated javadoc
-into svn each time you need to re-generate.
-
-```
-1. cd ..
-2. mvn -DskipTests site
-3. mv target/site/apidocs site/target
-```
-
-## Running locally
-
-Before opening a pull request, you can preview your contributions by
-running from within the directory:
-
-```
-1. bundle exec jekyll serve
-2. Open [http://localhost:4000](http://localhost:4000)
-```
-
-## Pushing to site
-
-```
-1. cd site/target
-2. svn status
-3. You'll need to `svn add` any new files
-4. svn ci
-```
-
-Within a few minutes, svnpubsub should kick in and you'll be able to
-see the results at
-[foo.apache.org](https://foo.apache.org/).
-
-## Adding contributors
-
-To add a contributor to the project, or to modify existing contributors,
-edit `site/_data/contributors.yml`.
-The [project members]([http://localhost:4000/community.html#project-members]
-list will re-generate.
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/8d746789/build.sh
----------------------------------------------------------------------
diff --git a/build.sh b/build.sh
new file mode 100644
index 0000000..b65840d
--- /dev/null
+++ b/build.sh
@@ -0,0 +1,13 @@
+set -e
+cd site
+jekyll serve -d ../content_tmp
+COMMIT_HASH=`git rev-parse HEAD`
+cd ..
+git checkout asf-site
+rm -rf content
+mv content_tmp content
+echo "Committing changes to asf-site branch from master branch"
+git commit -m "from $COMMIT_HASH"
+echo "You are now on the asf-site branch"
+echo "Run git push origin asf-site to update the live site."
+set +e
[3/3] incubator-quarks-website git commit: QUARKS-28 Update README.md
to include instructions on testing the asf-site content and other minor
updates
Posted by wc...@apache.org.
QUARKS-28 Update README.md to include instructions on testing the asf-site content and other minor updates
Project: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/commit/c08e83f1
Tree: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/tree/c08e83f1
Diff: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/diff/c08e83f1
Branch: refs/heads/master
Commit: c08e83f1dc4d26076a2a8697eded297be134a3ec
Parents: fe3df5d
Author: Katherine Marsden <km...@apache.org>
Authored: Wed Mar 16 07:37:08 2016 -0700
Committer: Katherine Marsden <km...@apache.org>
Committed: Wed Mar 16 07:37:08 2016 -0700
----------------------------------------------------------------------
README.md | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/c08e83f1/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index ae85a11..02da671 100644
--- a/README.md
+++ b/README.md
@@ -45,10 +45,11 @@ If you are a committer, do the following:
1. Update the master branch with your (or a Pull Request's) change.
2. Push updated master to the asf remote master (https://git-wip-us.apache.org/repos/asf/incubator-quarks-site.git)
- 3. Run `build.sh` from the master branch directory (requires jekyll). This will:
- - checks out and updates the `asf-site` branch with a new commit of the build from the current branch
+ 3. Run `build.sh` from the master branch directory (requires jekyll). This checks out and updates the `asf-site` branch with a new commit of the build from the current branch
- 4. At this point, you should be on the `asf-site` branch. Simply push this branch to the asf remote and the site will automatically be updated within seconds.
+ 4. At this point, you should be on the `asf-site` branch. Simply push this branch to the asf remote with `git push origin asf-site` and the site will automatically be updated within seconds.
+
+Note: If you want to try out the website locally on the asf-site branch before you push, you can do so with `jekyll serve -d content --skip-initial-build` and point your browser to http://localhost:4000
Developing
-----------
[2/3] incubator-quarks-website git commit: [QUARKS-28] make sure we
git add in build.sh and add Developing section to README.md
Posted by wc...@apache.org.
[QUARKS-28] make sure we git add in build.sh and add Developing section to README.md
Project: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/commit/fe3df5d8
Tree: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/tree/fe3df5d8
Diff: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/diff/fe3df5d8
Branch: refs/heads/master
Commit: fe3df5d80053c73e56b3af4977d95cb5591567f8
Parents: 8d74678
Author: Katherine Marsden <km...@apache.org>
Authored: Tue Mar 15 16:10:29 2016 -0700
Committer: Katherine Marsden <km...@apache.org>
Committed: Tue Mar 15 16:10:29 2016 -0700
----------------------------------------------------------------------
README.md | 16 ++++++++++------
build.sh | 3 ++-
2 files changed, 12 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/fe3df5d8/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 2f4549a..ae85a11 100644
--- a/README.md
+++ b/README.md
@@ -37,20 +37,24 @@ If you would like to make a change to the site:
1. Fork the [github mirror](https://github.com/apache/incubator-quarks-website)
2. Create a new branch from `master`
3. Add commit(s) to your branch
- 4. Test your changes locally
+ 4. Test your changes locally (see Developing)
5. Open a pull request on the github mirror
6. A committer will merge your changes if all is good
If you are a committer, do the following:
- 1. Update the master branch with your (or a Pull Request's) change.
- 2. Push updated master to the asf remote master (https://git-wip-us.apache.org/repos/asf/incubator-quarks-site.git)
- 3. Run `build.sh` from the master branch directory (requires jekyll). This will:
+ 1. Update the master branch with your (or a Pull Request's) change.
+ 2. Push updated master to the asf remote master (https://git-wip-us.apache.org/repos/asf/incubator-quarks-site.git)
+ 3. Run `build.sh` from the master branch directory (requires jekyll). This will:
- checks out and updates the `asf-site` branch with a new commit of the build from the current branch
4. At this point, you should be on the `asf-site` branch. Simply push this branch to the asf remote and the site will automatically be updated within seconds.
-
-
+Developing
+-----------
+ 1. Make your changes under site
+ 2. cd site
+ 3. jekyll serve -d ../content_tmp
+ 4. point your browser to http://localhost:4000/
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/fe3df5d8/build.sh
----------------------------------------------------------------------
diff --git a/build.sh b/build.sh
index b65840d..5ef9992 100644
--- a/build.sh
+++ b/build.sh
@@ -1,11 +1,12 @@
set -e
cd site
-jekyll serve -d ../content_tmp
+jekyll build -d ../content_tmp
COMMIT_HASH=`git rev-parse HEAD`
cd ..
git checkout asf-site
rm -rf content
mv content_tmp content
+git add content
echo "Committing changes to asf-site branch from master branch"
git commit -m "from $COMMIT_HASH"
echo "You are now on the asf-site branch"