You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@bookkeeper.apache.org by si...@apache.org on 2017/08/09 20:59:33 UTC
[bookkeeper] branch master updated: Issue #416: Some small
post-release documentation fixes
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 eb31639 Issue #416: Some small post-release documentation fixes
eb31639 is described below
commit eb316394c7d4c4426cfb86d2a9fc794302e5ad0d
Author: Luc Perkins <lu...@gmail.com>
AuthorDate: Wed Aug 9 13:59:26 2017 -0700
Issue #416: Some small post-release documentation fixes
There were a few issues pointed out with the new BookKeeper website/documentation. This fixes issue #416 and makes a handful of spelling and wording fixes.
Author: Luc Perkins <lu...@gmail.com>
Reviewers: Sijie Guo <si...@apache.org>
This closes #426 from lucperkins/docs/small-post-release-fixes, closes #416
---
site/_config.yml | 2 +-
site/_data/popovers.yaml | 2 +-
site/_includes/head.html | 4 ++--
site/_includes/navbar.html | 2 +-
site/_includes/sidebar.html | 2 +-
site/css/style.sass | 5 +++--
site/docs/latest/releaseNotesTemplate.md | 2 +-
site/index.html | 1 +
8 files changed, 11 insertions(+), 9 deletions(-)
diff --git a/site/_config.yml b/site/_config.yml
index e9ac329..5b22804 100644
--- a/site/_config.yml
+++ b/site/_config.yml
@@ -1,5 +1,5 @@
title: Apache BookKeeper
-subtitle: A scalable, fault-tolerant, and low-latency storage serivce optimized for real-time workloads
+subtitle: A scalable, fault-tolerant, and low-latency storage service optimized for real-time workloads
github_repo: https://github.com/apache/bookkeeper
github_master: https://github.com/apache/bookkeeper/tree/master
permalink: pretty
diff --git a/site/_data/popovers.yaml b/site/_data/popovers.yaml
index b54ec08..8b5347c 100644
--- a/site/_data/popovers.yaml
+++ b/site/_data/popovers.yaml
@@ -4,7 +4,7 @@
d: A ledger is a sequence of entries written to BookKeeper. Entries are written sequentially to ledgers and at most once, giving ledgers append-only semantics.
- term: bookie
d: |
- A bookie is an individial BookKeeper storage server.
+ A bookie is an individual BookKeeper storage server.
Bookies store the content of ledgers and act as a distributed ensemble.
- term: rereplication
diff --git a/site/_includes/head.html b/site/_includes/head.html
index 53cc3c4..bd92924 100644
--- a/site/_includes/head.html
+++ b/site/_includes/head.html
@@ -13,8 +13,8 @@
<script src="{{ site.baseurl }}js/tippy.min.js"></script>
<script type="text/javascript">
- var shiftWindow = function() { scrollBy(0, -108); };
+ var shiftWindow = function() { scrollBy(0, -25); };
window.addEventListener("hashchange", shiftWindow);
window.addEventListener("pageshow", shiftWindow);
function load() { if (window.location.hash) shiftWindow(); }
-</script>
+</script>
\ No newline at end of file
diff --git a/site/_includes/navbar.html b/site/_includes/navbar.html
index 329dbc4..ceb9acb 100644
--- a/site/_includes/navbar.html
+++ b/site/_includes/navbar.html
@@ -19,7 +19,7 @@
</a>
-->
- <div class="navbar-burger" data-target="bkNav">
+ <div class="navbar-burger burger" data-target="bkNav">
<span></span>
<span></span>
<span></span>
diff --git a/site/_includes/sidebar.html b/site/_includes/sidebar.html
index c97c586..d3d9de4 100644
--- a/site/_includes/sidebar.html
+++ b/site/_includes/sidebar.html
@@ -2,7 +2,7 @@
<aside class="sidebar">
{% assign doc_version = page.url | replace:'/',' ' | truncatewords: 2 | remove:'...' | replace:'docs','' | lstrip %}
<a class="button is-info">
- Version : {{ doc_version }}
+ Version: {{ doc_version }}
</a>
<hr />
{% for group in site.data.sidebar.groups %}{% assign docs = group.docs %}
diff --git a/site/css/style.sass b/site/css/style.sass
index 14917bd..a7d0898 100644
--- a/site/css/style.sass
+++ b/site/css/style.sass
@@ -114,11 +114,12 @@ body
font-size: 1.25em
h1.bk-title
- font-size: $base-font-size * 3.5
+ font-size: $base-font-size * 4.25
+ margin-bottom: 1.5rem
h2.bk-subtitle
font-size: $base-font-size * 2
- margin-bottom: 1rem
+ margin-bottom: 1.5rem
.bk-docs-container, .bk-community-container
margin: $docs-container-vertical-margin auto $docs-container-vertical-margin * 2 auto
diff --git a/site/docs/latest/releaseNotesTemplate.md b/site/docs/latest/releaseNotesTemplate.md
index 45f727d..15822e6 100644
--- a/site/docs/latest/releaseNotesTemplate.md
+++ b/site/docs/latest/releaseNotesTemplate.md
@@ -4,7 +4,7 @@ title: Apache BookKeeper 4.5.0-SNAPSHOT Release Notes
[provide a summary of this release]
-Apache BookKeeper users are encouraged to upgrade to `{{ site.latest_version }}`. The technical details of this release are summarized
+Apache BookKeeper users are encouraged to upgrade to {{ site.latest_version }}. The technical details of this release are summarized
below.
## Highlights
diff --git a/site/index.html b/site/index.html
index b0726b7..6e77ff7 100644
--- a/site/index.html
+++ b/site/index.html
@@ -52,5 +52,6 @@ title: Home
</main>
{% include footer.html %}
+ {% include javascript.html %}
</body>
</html>
--
To stop receiving notification emails like this one, please contact
['"commits@bookkeeper.apache.org" <co...@bookkeeper.apache.org>'].