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/07 20:13:04 UTC
[bookkeeper] branch branch-4.5 updated: ISSUE #349: Move `security`
docs under `latest` (hotfix)
This is an automated email from the ASF dual-hosted git repository.
sijie pushed a commit to branch branch-4.5
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git
The following commit(s) were added to refs/heads/branch-4.5 by this push:
new c35b875 ISSUE #349: Move `security` docs under `latest` (hotfix)
c35b875 is described below
commit c35b875a701c52a8021339668379ddf584e8df50
Author: Sijie Guo <si...@apache.org>
AuthorDate: Mon Aug 7 13:12:28 2017 -0700
ISSUE #349: Move `security` docs under `latest` (hotfix)
Descriptions of the changes in this PR:
#325 moved the docs to under `docs/latest`. so we need to move `security` docs to under `docs/latest/security`.
At the same time, fix two broken links.
Author: Sijie Guo <si...@apache.org>
Reviewers: Matteo Merli <mm...@apache.org>
This closes #408 from sijie/fix_bad_merges, closes #349
(cherry picked from commit bee543487a2dd18034df2030a175b8f437f8fae3)
Signed-off-by: Sijie Guo <si...@apache.org>
---
site/_data/sidebar.yaml | 16 ++++++++--------
site/_includes/sidebar.html | 4 ++--
site/docs/latest/admin/upgrade.md | 4 ++--
.../{security/index.md => latest/security/overview.md} | 14 +++++++-------
site/docs/{ => latest}/security/sasl.md | 0
site/docs/{ => latest}/security/tls.md | 2 +-
site/docs/{ => latest}/security/zookeeper.md | 0
site/scripts/staging-website.sh | 4 +++-
8 files changed, 23 insertions(+), 21 deletions(-)
diff --git a/site/_data/sidebar.yaml b/site/_data/sidebar.yaml
index 1211a48..9127619 100644
--- a/site/_data/sidebar.yaml
+++ b/site/_data/sidebar.yaml
@@ -45,24 +45,24 @@ groups:
endpoint: ledger-adv-api
- name: DistributedLog
endpoint: distributedlog-api
-- name: Development
- dir: development
- docs:
- - name: BookKeeper protocol
- endpoint: protocol
- #- name: Codebase
- # endpoint: codebase
- name: Security
dir: security
docs:
- name: Overview
- endpoint: index
+ endpoint: overview
- name: TLS Authentication
endpoint: tls
- name: SASL Authentication
endpoint: sasl
- name: ZooKeeper Authentication
endpoint: zookeeper
+- name: Development
+ dir: development
+ docs:
+ - name: BookKeeper protocol
+ endpoint: protocol
+ #- name: Codebase
+ # endpoint: codebase
- name: Reference
dir: reference
docs:
diff --git a/site/_includes/sidebar.html b/site/_includes/sidebar.html
index 685a9b3..c97c586 100644
--- a/site/_includes/sidebar.html
+++ b/site/_includes/sidebar.html
@@ -11,9 +11,9 @@
</p>
<ul class="sidebar-items">
{% for doc in docs %}
- {% capture doc_url %}{{ site.baseurl }}docs/{{ doc_version }}/{{ group.dir }}/{{ doc.endpoint }}/{% endcapture %}
+ {% capture doc_url %}../../{{ group.dir }}/{{ doc.endpoint }}/{% endcapture %}
<li{% if doc_url == page.url %} class="active"{% endif %}>
- <a href="{{ site.baseurl }}docs/{{ doc_version }}/{{ group.dir }}/{{ doc.endpoint }}">
+ <a href="../../{{ group.dir }}/{{ doc.endpoint }}">
{{ doc.name }}
</a>
</li>
diff --git a/site/docs/latest/admin/upgrade.md b/site/docs/latest/admin/upgrade.md
index 9addee4..456df99 100644
--- a/site/docs/latest/admin/upgrade.md
+++ b/site/docs/latest/admin/upgrade.md
@@ -2,7 +2,7 @@
title: Upgrade
---
-> If you have questions about upgrades (or need help), please feel free to reach out to us by [mailing list](/community/mailing-lists) or [Slack Channel](/community/slack).
+> If you have questions about upgrades (or need help), please feel free to reach out to us by [mailing list]({{ site.baseurl }}community/mailing-lists) or [Slack Channel]({{ site.baseurl }}community/slack).
## Overview
@@ -69,5 +69,5 @@ However, we list a list of things that you might want to know.
2. `multi journals` is a non-rollbackable feature. If you configure a bookie to use multiple journals on 4.5.x you can not roll the bookie back to use 4.4.x. You have
to take a bookie out and recover it if you want to rollback to 4.4.x.
-If you are planning to upgrade a non-secured cluster to a secured cluster enabling security features in 4.5.0, please read [BookKeeper Security](../../security) for more details.
+If you are planning to upgrade a non-secured cluster to a secured cluster enabling security features in 4.5.0, please read [BookKeeper Security](../../security/overview) for more details.
diff --git a/site/docs/security/index.md b/site/docs/latest/security/overview.md
similarity index 69%
rename from site/docs/security/index.md
rename to site/docs/latest/security/overview.md
index 059a309..62da8ed 100644
--- a/site/docs/security/index.md
+++ b/site/docs/latest/security/overview.md
@@ -1,14 +1,14 @@
---
title: BookKeeper Security
-next: ./tls.html
+next: ../tls
---
In the 4.5.0 release, the BookKeeper community added a number of features that can be used, together or separately, to secure a BookKeeper cluster.
The following security measures are currently supported:
-1. Authentication of connections to bookies from clients, using either [TLS](./tls) or [SASL (Kerberos)](./sasl).
-2. Authentication of connections from clients, bookies, autorecovery daemons to [ZooKeeper](./zookeeper), when using zookeeper based ledger managers.
-3. Encryption of data transferred between bookies and clients, between bookies and autorecovery daemons using [TLS](./tls).
+1. Authentication of connections to bookies from clients, using either [TLS](../tls) or [SASL (Kerberos)](../sasl).
+2. Authentication of connections from clients, bookies, autorecovery daemons to [ZooKeeper](../zookeeper), when using zookeeper based ledger managers.
+3. Encryption of data transferred between bookies and clients, between bookies and autorecovery daemons using [TLS](../tls).
It’s worth noting that security is optional - non-secured clusters are supported, as well as a mix of authenticated, unauthenticated, encrypted and non-encrypted clients.
@@ -16,6 +16,6 @@ NOTE: currently `authorization` is not yet available in `4.5.0`. The Apache Book
## Next Steps
-- [Encryption and Authentication using TLS](./tls)
-- [Authentication using SASL](./sasl)
-- [ZooKeeper Authentication](./zookeeper)
+- [Encryption and Authentication using TLS](../tls)
+- [Authentication using SASL](../sasl)
+- [ZooKeeper Authentication](../zookeeper)
diff --git a/site/docs/security/sasl.md b/site/docs/latest/security/sasl.md
similarity index 100%
rename from site/docs/security/sasl.md
rename to site/docs/latest/security/sasl.md
diff --git a/site/docs/security/tls.md b/site/docs/latest/security/tls.md
similarity index 99%
rename from site/docs/security/tls.md
rename to site/docs/latest/security/tls.md
index ff5ac2c..cd250ab 100644
--- a/site/docs/security/tls.md
+++ b/site/docs/latest/security/tls.md
@@ -1,6 +1,6 @@
---
title: Encryption and Authentication using TLS
-prev: ../index.html
+prev: ../overview
next: ../sasl
---
diff --git a/site/docs/security/zookeeper.md b/site/docs/latest/security/zookeeper.md
similarity index 100%
rename from site/docs/security/zookeeper.md
rename to site/docs/latest/security/zookeeper.md
diff --git a/site/scripts/staging-website.sh b/site/scripts/staging-website.sh
index 52ee7d3..f4eed24 100755
--- a/site/scripts/staging-website.sh
+++ b/site/scripts/staging-website.sh
@@ -28,12 +28,14 @@ echo "GENERATE SITE DIR: $LOCAL_GENERATED_DIR"
(
rm -rf $TMP_DIR
- mkdir -p $TMP_DIR
+ mkdir $TMP_DIR
cd $TMP_DIR
# clone the remote repo
git clone "https://$STAGING_REPO" .
+ # if the remote is empty, we should create the `docs` directory
+ mkdir -p $TMP_DIR/docs
# copy the local generated dir
cp -r $LOCAL_GENERATED_DIR/* $TMP_DIR/docs/
--
To stop receiving notification emails like this one, please contact
['"commits@bookkeeper.apache.org" <co...@bookkeeper.apache.org>'].