This is an automated email from the ASF dual-hosted git repository. sijie pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/bookkeeper.git
The following commit(s) were added to refs/heads/master by this push: new 908972c Revamped downloads page 908972c is described below commit 908972c73be2743b3aaa369a6d97fff8e46295f8 Author: Luc Perkins <lucperk...@gmail.com> AuthorDate: Fri Feb 2 16:36:01 2018 -0800 Revamped downloads page This PR addresses issue #1090 and significantly revamps the downloads page to bring it in line with Apache standards. It also makes some changes to the website's general setup and build process to make that process less brittle. Author: Luc Perkins <lucperk...@gmail.com> Reviewers: Jia Zhai <None>, Sijie Guo <si...@apache.org> This closes #1104 from lucperkins/lperkins/asf-compliance --- site/Gemfile | 10 ++---- site/Gemfile.lock | 61 +++++++++++++++++++---------------- site/Makefile | 16 ++++----- site/_config.yml | 4 +-- site/docs/4.5.0/example.md | 6 ---- site/docs/4.5.1/example.md | 6 ---- site/docs/4.6.0/example.md | 6 ---- site/docs/4.6.1/example.md | 6 ---- site/docs/latest/example.md | 6 ---- site/docs/latest/overview/overview.md | 21 ++++++------ site/releases.md | 43 ++++++++++++++++++++---- 11 files changed, 92 insertions(+), 93 deletions(-) diff --git a/site/Gemfile b/site/Gemfile index 9ac4c81..e0953d6 100644 --- a/site/Gemfile +++ b/site/Gemfile @@ -2,10 +2,6 @@ source 'https://rubygems.org' ruby '2.4.1' -gem 'jekyll', '3.4.3' -gem 'nokogiri', '1.8.1' -gem 'jekyll-toc' - -group :jekyll_plugins do - gem 'jekyll-livereload', '0.2.2' -end +gem 'jekyll', '3.7.0' +gem 'nokogiri' +gem 'jekyll-toc', '0.2.1' diff --git a/site/Gemfile.lock b/site/Gemfile.lock index e219637..a9c775a 100644 --- a/site/Gemfile.lock +++ b/site/Gemfile.lock @@ -1,66 +1,73 @@ GEM remote: https://rubygems.org/ specs: - addressable (2.5.1) - public_suffix (~> 2.0, >= 2.0.2) + addressable (2.5.2) + public_suffix (>= 2.0.2, < 4.0) colorator (1.1.0) + concurrent-ruby (1.0.5) em-websocket (0.5.1) eventmachine (>= 0.12.9) http_parser.rb (~> 0.6.0) - eventmachine (1.2.3) + eventmachine (1.2.5) ffi (1.9.18) forwardable-extended (2.6.0) http_parser.rb (0.6.0) - jekyll (3.4.3) + i18n (0.9.3) + concurrent-ruby (~> 1.0) + jekyll (3.7.0) addressable (~> 2.4) colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 0.7) jekyll-sass-converter (~> 1.0) - jekyll-watch (~> 1.1) - kramdown (~> 1.3) - liquid (~> 3.0) + jekyll-watch (~> 2.0) + kramdown (~> 1.14) + liquid (~> 4.0) mercenary (~> 0.3.3) pathutil (~> 0.9) - rouge (~> 1.7) + rouge (>= 1.7, < 4) safe_yaml (~> 1.0) - jekyll-livereload (0.2.2) - em-websocket (~> 0.5) - jekyll (~> 3.0) - jekyll-sass-converter (1.5.0) + jekyll-sass-converter (1.5.1) sass (~> 3.4) jekyll-toc (0.2.1) nokogiri (~> 1.6) - jekyll-watch (1.5.0) - listen (~> 3.0, < 3.1) - kramdown (1.13.2) - liquid (3.0.6) - listen (3.0.8) + jekyll-watch (2.0.0) + listen (~> 3.0) + kramdown (1.16.2) + liquid (4.0.0) + listen (3.1.5) rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) + ruby_dep (~> 1.2) mercenary (0.3.6) mini_portile2 (2.3.0) nokogiri (1.8.1) mini_portile2 (~> 2.3.0) - pathutil (0.14.0) + pathutil (0.16.1) forwardable-extended (~> 2.6) - public_suffix (2.0.5) - rb-fsevent (0.9.8) + public_suffix (3.0.1) + rb-fsevent (0.10.2) rb-inotify (0.9.10) ffi (>= 0.5.0, < 2) - rouge (1.11.1) + rouge (3.1.1) + ruby_dep (1.5.0) safe_yaml (1.0.4) - sass (3.4.24) + sass (3.5.5) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) PLATFORMS ruby DEPENDENCIES - jekyll (= 3.4.3) - jekyll-livereload (= 0.2.2) - jekyll-toc - nokogiri (= 1.8.1) + jekyll (= 3.7.0) + jekyll-toc (= 0.2.1) + nokogiri RUBY VERSION ruby 2.4.1p111 BUNDLED WITH - 1.15.1 + 1.16.1 diff --git a/site/Makefile b/site/Makefile index a9090a1..346de7d 100644 --- a/site/Makefile +++ b/site/Makefile @@ -1,6 +1,5 @@ -BUNDLER_VERSION = 1.15.1 -BUNDLE = bundle _${BUNDLER_VERSION}_ -JEKYLL = ${BUNDLE} exec jekyll +BUNDLE := bundle +JEKYLL := $(BUNDLE) exec jekyll dev: code . @@ -12,18 +11,17 @@ clean: setup: gem install bundler \ - -v ${BUNDLER_VERSION} \ --no-rdoc \ --no-ri - NOKOGIRI_USE_SYSTEM_LIBRARIES=true ${BUNDLE} install \ + NOKOGIRI_USE_SYSTEM_LIBRARIES=true $(BUNDLE) install \ --path vendor/bundle build: clean - ${JEKYLL} build \ + $(JEKYLL) build \ --config _config.yml apache: clean - JEKYLL_ENV=production ${JEKYLL} build \ + JEKYLL_ENV=production $(JEKYLL) build \ --config _config.yml,_config.apache.yml javadoc: @@ -33,10 +31,10 @@ latest_javadoc: scripts/javadoc-gen.sh "latest" staging: clean - ${JEKYLL} build --config _config.yml,_config.staging.yml + $(JEKYLL) build --config _config.yml,_config.staging.yml serve: build - ${JEKYLL} serve \ + $(JEKYLL) serve \ --incremental \ --livereload \ --config _config.yml,_config.local.yml diff --git a/site/_config.yml b/site/_config.yml index 85961ed..9a059c3 100644 --- a/site/_config.yml +++ b/site/_config.yml @@ -7,11 +7,9 @@ baseurl: / destination: local-generated twitter_url: https://twitter.com/asfbookkeeper -livereload: true - versions: - "4.6.1" -# [next_version_placehodler] +# [next_version_placeholder] - "4.6.0" - "4.5.1" - "4.5.0" diff --git a/site/docs/4.5.0/example.md b/site/docs/4.5.0/example.md deleted file mode 100644 index 7dbc697..0000000 --- a/site/docs/4.5.0/example.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Example doc -subtitle: Just for experimentation purposes. ---- - -{% pop ledger %} diff --git a/site/docs/4.5.1/example.md b/site/docs/4.5.1/example.md deleted file mode 100644 index 7dbc697..0000000 --- a/site/docs/4.5.1/example.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Example doc -subtitle: Just for experimentation purposes. ---- - -{% pop ledger %} diff --git a/site/docs/4.6.0/example.md b/site/docs/4.6.0/example.md deleted file mode 100644 index 7dbc697..0000000 --- a/site/docs/4.6.0/example.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Example doc -subtitle: Just for experimentation purposes. ---- - -{% pop ledger %} diff --git a/site/docs/4.6.1/example.md b/site/docs/4.6.1/example.md deleted file mode 100644 index 7dbc697..0000000 --- a/site/docs/4.6.1/example.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Example doc -subtitle: Just for experimentation purposes. ---- - -{% pop ledger %} diff --git a/site/docs/latest/example.md b/site/docs/latest/example.md deleted file mode 100644 index 7dbc697..0000000 --- a/site/docs/latest/example.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Example doc -subtitle: Just for experimentation purposes. ---- - -{% pop ledger %} diff --git a/site/docs/latest/overview/overview.md b/site/docs/latest/overview/overview.md index 7c8f545..a20158a 100644 --- a/site/docs/latest/overview/overview.md +++ b/site/docs/latest/overview/overview.md @@ -20,26 +20,27 @@ specific language governing permissions and limitations under the License. --> -This documentation is for Apache BookKeeper™ version `{{ site.latest_version }}`. +This documentation is for Apache BookKeeper™ version {{ site.latest_version }}. -Apache BookKeeper™ is a scalable, fault tolerant and low latency storage service optimized for realtime workloads. -It offers `durability`, `replication` and `strong consistency` as essentials for building reliable real-time applications. +Apache BookKeeper™ is a scalable, fault-tolerant, low-latency storage service optimized for real-time workloads. It offers durability, replication, and strong consistency as essentials for building reliable real-time applications. -It is suitable for being used in following scenerios: +BookKeeper is suitable for a wide variety of use cases, including: -- [WAL](https://en.wikipedia.org/wiki/Write-ahead_logging) (Write-Ahead-Logging), e.g. HDFS [namenode](https://hadoop.apache.org/docs/r2.5.2/hadoop-project-dist/hadoop-hdfs/HDFSHighAvailabilityWithNFS.html#BookKeeper_as_a_Shared_storage_EXPERIMENTAL). -- Message Store, e.g. [Apache Pulsar](https://pulsar.incubator.apache.org/). -- Offset/Cursor Store, e.g. Apache Pulsar. -- Object/Blob Store, e.g. storing snapshots to replicated state machines. +Use case | Example +:--------|:------- +[WAL](https://en.wikipedia.org/wiki/Write-ahead_logging) (write-ahead logging) | The HDFS [namenode](https://hadoop.apache.org/docs/r2.5.2/hadoop-project-dist/hadoop-hdfs/HDFSHighAvailabilityWithNFS.html#BookKeeper_as_a_Shared_storage_EXPERIMENTAL) +Message storage | [Apache Pulsar](http://pulsar.incubator.apache.org/docs/latest/getting-started/ConceptsAndArchitecture/#persistent-storage) +Offset/cursor storage | [Apache Pulsar](http://pulsar.incubator.apache.org/docs/latest/getting-started/ConceptsAndArchitecture/#persistent-storage) +Object/[BLOB](https://en.wikipedia.org/wiki/Binary_large_object) storage | Storing snapshots to replicated state machines Learn more about Apache BookKeeper™ and what it can do for your organization: - [Apache BookKeeper {{ site.latest_version }} Release Notes](../releaseNotes) - [Java API docs](../../api/javadoc) -Or start using Apache BookKeeper today. +Or start [using](../../getting-started/installation) Apache BookKeeper today. -### Users +### Users - **Concepts**: Start with [concepts](../../getting-started/concepts). This will help you to fully understand the other parts of the documentation, including the setup, integration and operation guides. diff --git a/site/releases.md b/site/releases.md index aa70419..785c373 100644 --- a/site/releases.md +++ b/site/releases.md @@ -3,15 +3,45 @@ title: Apache BookKeeper™ Releases layout: community --- -## Download +{% capture root_url %}https://www.apache.org/dist/bookkeeper{% endcapture %} +{% capture latest_source_url %}{{ root_url }}/bookkeeper-{{ site.latest_release }}/bookkeeper-{{ site.latest_release }}-src.tar.gz{% endcapture %} +{% capture latest_bin_url %}{{ root_url }}/bookkeeper-{{ site.latest_release }}/bookkeeper-server-{{ site.latest_release }}-bin.tar.gz{% endcapture %} +{% capture stable_source_url %}{{ root_url }}/bookkeeper-{{ site.stable_release }}/bookkeeper-{{ site.stable_release }}-src.tar.gz{% endcapture %} +{% capture stable_bin_url %}{{ root_url }}//bookkeeper-{{ site.stable_release }}/bookkeeper-server-{{ site.stable_release }}-bin.tar.gz{% endcapture %} -{{ site.latest_release }} is latest release. The current stable version is {{ site.stable_release }}. +Version **{{ site.latest_release }}** is the [latest release](#latest-releases-version-{{ site.latest_release | remove: "." }}) of BookKeeper. The current [stable version](#latest-stable-releases-version-{{ site.stable_release | remove: "." }}) is **{{ site.stable_release }}**. Releases can be downloaded from BookKeeper's [Apache mirrors](http://www.apache.org/dyn/closer.cgi/bookkeeper) site or using the instructions below. -Releases are available to download from Apache mirrors: [Download](http://www.apache.org/dyn/closer.cgi/bookkeeper) +> You can verify your download by following these [procedures](http://www.apache.org/info/verification.html) and using these [KEYS](https://www.apache.org/dist/bookkeeper/KEYS). -You can verify your download by following these [procedures](http://www.apache.org/info/verification.html) and using these [KEYS](https://dist.apache.org/repos/dist/release/bookkeeper/KEYS). +If you want to download older, archived releases, they are available in the [Apache archive](http://archive.apache.org/dist/bookkeeper/). -If you want to download older releases, they are available in the [Apache archive](http://archive.apache.org/dist/bookkeeper/). +## Latest release (version {{ site.latest_release }}) + +Release | Link | Crypto files +:-------|:-----|:------------ +Source | [bookkeeper-{{ site.latest_release }}-src.tar.gz]({{ latest_source_url }}) | [asc]({{ latest_source_url }}.asc), [md5]({{ latest_source_url }}.md5), [sha1]({{ latest_source_url }}.sha1) +Binary | [bookkeeper-server-{{ site.latest_release }}-bin.tar.gz]({{ latest_bin_url }}) | [asc]({{ latest_bin_url }}.asc), [md5]({{ latest_bin_url }}.md5), [sha1]({{ latest_bin_url }}.sha1) + +## Latest stable release (version {{ site.stable_release }}) + +Release | Link | Crypto files +:-------|:-----|:------------ +Source | [bookkeeper-{{ site.stable_release }}-src.tar.gz]({{ stable_source_url }}) | [asc]({{ stable_source_url }}.asc), [md5]({{ stable_source_url }}.md5), [sha1]({{ stable_source_url }}.sha1) +Binary | [bookkeeper-server-{{ site.stable_release }}-bin.tar.gz]({{ stable_bin_url }}) | [asc]({{ stable_bin_url }}.asc), [md5]({{ stable_bin_url }}.md5), [sha1]({{ stable_bin_url }}.sha1) + +## Recent releases + +{% for version in site.versions %}{% if version != site.latest_release %} +{% capture root_url %}https://www.apache.org/dist/bookkeeper/bookkeeper-{{ version }}{% endcapture %} +{% capture src_root %}{{ root_url }}/bookkeeper-{{ version }}-src.tar.gz{% endcapture %} +{% capture bin_root %}{{ root_url }}/bookkeeper-server-{{ version }}-bin.tar.gz{% endcapture %} +### Version {{ version }} + +Release | Link | Crypto files +:-------|:-----|:------------ +Source | [bookkeeper-{{ version }}-src.tar.gz]({{ src_root }}) | [asc]({{ src_root }}.asc), [md5]({{ src_root }}.md5), [sha1]({{ src_root }}.sha1) +Binary | [bookkeeper-server-{{ version }}-bin.tar.gz]({{ bin_root }}) | [asc]({{ bin_root }}.asc), [md5]({{ bin_root }}.md5), [sha1]({{ bin_root }}.sha1) +{% endif %}{% endfor %} ## Getting Started @@ -144,5 +174,4 @@ See [BookKeeper 4.1.0 Release Notes]({{ site.baseurl }}archives/docs/r4.1.0/rele ### 7 Dec, 2011: release 4.0.0 available This is the first release of BookKeeper as a subproject of Zookeeper. -See [BookKeeper 4.0.0 Release Notes]({{ site.baseurl }}archives/docs/r4.0.0/releaseNotes.html) for details. - +See [BookKeeper 4.0.0 Release Notes]({{ site.baseurl }}archives/docs/r4.0.0/releaseNotes.html) for details. \ No newline at end of file -- To stop receiving notification emails like this one, please contact si...@apache.org.