bookkeeper-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From zhai...@apache.org
Subject [bookkeeper] branch master updated: ISSUE #427: [WEBSITE] sidebar doesn't work on documentation index page
Date Thu, 10 Aug 2017 01:41:31 GMT
This is an automated email from the ASF dual-hosted git repository.

zhaijia 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 f5c96eb  ISSUE #427: [WEBSITE] sidebar doesn't work on documentation index page
f5c96eb is described below

commit f5c96ebc9e5952a89f86d0a50093ff65c821701b
Author: Sijie Guo <sijie@apache.org>
AuthorDate: Thu Aug 10 09:41:20 2017 +0800

    ISSUE #427: [WEBSITE] sidebar doesn't work on documentation index page
    
    Descriptions of the changes in this PR:
    
    sidebar uses `../../` for relative paths. in order to make this work, we need to move
any pages under `docs` on level down and not use `index.md`.
    
    Author: Sijie Guo <sijie@apache.org>
    
    Reviewers: Jia Zhai <None>, Luc Perkins <None>, Matteo Merli <None>
    
    This closes #428 from sijie/issue_427, closes #427
---
 site/_includes/navbar.html                              |  4 ++--
 site/docs/latest/{index.md => overview/overview.md}     | 14 +++++++-------
 site/docs/latest/{ => overview}/releaseNotes.md         |  0
 site/docs/latest/{ => overview}/releaseNotesTemplate.md |  0
 site/scripts/release.sh                                 |  2 +-
 5 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/site/_includes/navbar.html b/site/_includes/navbar.html
index ceb9acb..bd8f408 100644
--- a/site/_includes/navbar.html
+++ b/site/_includes/navbar.html
@@ -31,7 +31,7 @@
       <div class="navbar-item has-dropdown is-hoverable">
         <a class="navbar-link">Documentation</a>
         <div class="navbar-dropdown is-boxed">
-          <a class="navbar-item" href="{{ site.baseurl }}docs/latest/index.html">
+          <a class="navbar-item" href="{{ site.baseurl }}docs/latest/overview/overview">
             Version {{ site.latest_version}}
             <span class="tag is-warning">Development</span>
           </a>
@@ -43,7 +43,7 @@
           </a>
           <hr class="dropdown-divider">
           {% for version in site.versions %}
-          <a class="navbar-item" href="{{ site.baseurl }}docs/{{version}}/index.html">
+          <a class="navbar-item" href="{{ site.baseurl }}docs/{{version}}/overview/overview">
             Release {{version}}
             {% if version == site.stable_release %}<span class="tag is-success">Stable</span>{%
endif %}
           </a>
diff --git a/site/docs/latest/index.md b/site/docs/latest/overview/overview.md
similarity index 70%
rename from site/docs/latest/index.md
rename to site/docs/latest/overview/overview.md
index ad8d47a..e17bfaa 100644
--- a/site/docs/latest/index.md
+++ b/site/docs/latest/overview/overview.md
@@ -34,23 +34,23 @@ It is suitable for being used in following scenerios:
 
 Learn more about Apache BookKeeper and what it can do for your organization:
 
-- [Apache BookKeeper {{ site.latest_version }} Release Notes](./releaseNotes)
+- [Apache BookKeeper {{ site.latest_version }} Release Notes](../releaseNotes)
 
 Or start using Apache BookKeeper today.
 
 ### Users 
 
-- **Concepts**: Start with [concepts](./getting-started/concepts). This will help you to
fully understand
+- **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.
-- **Getting Started**: Install [Apache BookKeeper](./getting-started/installation) and run
bookies [locally](./getting-started/run-locally)
-- **API**: Read the [API](./api/overview) documentation to learn how to use Apache BookKeeper
to build your applications.
-- **Deployment**: The [Deployment Guide](./deployment/manual) shows how to deploy Apache
BookKeeper to production clusters.
+- **Getting Started**: Install [Apache BookKeeper](../../getting-started/installation) and
run bookies [locally](../../getting-started/run-locally)
+- **API**: Read the [API](../../api/overview) documentation to learn how to use Apache BookKeeper
to build your applications.
+- **Deployment**: The [Deployment Guide](../../deployment/manual) shows how to deploy Apache
BookKeeper to production clusters.
 
 ### Administrators
 
-- **Operations**: The [Admin Guide](./admin) shows how to run Apache BookKeeper on production,
what are the production
+- **Operations**: The [Admin Guide](../../admin/bookies) shows how to run Apache BookKeeper
on production, what are the production
     considerations and best practices.
 
 ### Contributors
 
-- **Details**: Learn [design details](./development/protocol) to know more internals.
+- **Details**: Learn [design details](../../development/protocol) to know more internals.
diff --git a/site/docs/latest/releaseNotes.md b/site/docs/latest/overview/releaseNotes.md
similarity index 100%
rename from site/docs/latest/releaseNotes.md
rename to site/docs/latest/overview/releaseNotes.md
diff --git a/site/docs/latest/releaseNotesTemplate.md b/site/docs/latest/overview/releaseNotesTemplate.md
similarity index 100%
rename from site/docs/latest/releaseNotesTemplate.md
rename to site/docs/latest/overview/releaseNotesTemplate.md
diff --git a/site/scripts/release.sh b/site/scripts/release.sh
index 215964e..2dd4129 100755
--- a/site/scripts/release.sh
+++ b/site/scripts/release.sh
@@ -52,7 +52,7 @@ cd ${DOC_HOME}/docs/${RELEASE_VERSION}
 find . -name "*.md" | xargs sed -i'.bak' "s/{{ site\.latest_version }}/${RELEASE_VERSION}/"
 find . -name "*.md" | xargs sed -i'.bak' "s/${LATEST_VERSION}/${RELEASE_VERSION}/"
 find . -name "*.md.bak" | xargs rm
-cp releaseNotesTemplate.md releaseNotes.md
+cp overview/releaseNotesTemplate.md overview/releaseNotes.md
 
 # go to doc home
 

-- 
To stop receiving notification emails like this one, please contact
['"commits@bookkeeper.apache.org" <commits@bookkeeper.apache.org>'].

Mime
View raw message