This is an automated email from the ASF dual-hosted git repository.
chengpan pushed a commit to branch branch-0.12
in repository https://gitbox.apache.org/repos/asf/zeppelin.git
The following commit(s) were added to refs/heads/branch-0.12 by this push:
new 671eca8828 [ZEPPELIN-6112] Fix running documentation website server
671eca8828 is described below
commit 671eca882836b21a668ff5fc2db3819f52b72c4e
Author: ChanHo Lee <chanho0...@gmail.com>
AuthorDate: Mon Sep 30 00:19:59 2024 +0900
[ZEPPELIN-6112] Fix running documentation website server
### What is this PR for?
The current command for running the website is not functioning correctly.
Fixing this issue will enable developers to verify that the changes made to
the documentation files are properly reflected on the website.
### What type of PR is it?
Bug Fix
### Todos
* [ ] - Task
### What is the Jira issue?
* Open an issue on Jira https://issues.apache.org/jira/browse/ZEPPELIN/6112
* Put link here, and add [ZEPPELIN-*Jira number*] in PR title, eg.
[ZEPPELIN-533]
### How should this be tested?
Run the website server using the following command and check if the site is
served at http://localhost:4000:
```bash
docker run --rm -it \
-v $PWD:/docs \
-w /docs \
-p '4000:4000' \
ruby:3.3.5 \
bash -c "bundle install && bundle exec jekyll serve --watch --host
0.0.0.0"
```
### Questions:
* Does the license files need to update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No
Closes #4850 from tbonelee/fix-docs.
Signed-off-by: Cheng Pan <cheng...@apache.org>
(cherry picked from commit aa5abd572d6f67777cc13a84a6282fe747e07472)
Signed-off-by: Cheng Pan <cheng...@apache.org>
---
docs/Gemfile | 6 +
docs/Gemfile.lock | 324 ++++++++++++++++++++++++++++++++++++++++--------
docs/README.md | 4 +-
docs/_config.yml | 2 +-
docs/_includes/JB/setup | 4 +-
5 files changed, 285 insertions(+), 55 deletions(-)
diff --git a/docs/Gemfile b/docs/Gemfile
index 655775a054..620e29f3b0 100644
--- a/docs/Gemfile
+++ b/docs/Gemfile
@@ -15,3 +15,9 @@
#
source 'https://rubygems.org'
gem 'github-pages'
+gem 'redcarpet'
+gem 'jekyll-twitter-plugin'
+gem 'nokogiri', '1.15.4'
+gem 'mini_portile2', '2.8.4'
+
+gem "webrick", "~> 1.8" # By upgrading ruby to 3.x
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
index aaccff9451..9475b4a3ee 100644
--- a/docs/Gemfile.lock
+++ b/docs/Gemfile.lock
@@ -1,61 +1,285 @@
GEM
remote: https://rubygems.org/
specs:
- RedCloth (4.2.9)
- classifier (1.3.3)
- fast-stemmer (>= 1.0.0)
- colorator (0.1)
- commander (4.1.5)
- highline (~> 1.6.11)
- fast-stemmer (1.0.2)
- ffi (1.9.3)
- github-pages (10)
- RedCloth (= 4.2.9)
- jekyll (= 1.3.0)
- kramdown (= 1.2.0)
- liquid (= 2.5.4)
- maruku (= 0.6.1)
- rdiscount (= 2.1.7)
- redcarpet (= 2.3.0)
- highline (1.6.20)
- jekyll (1.3.0)
- classifier (~> 1.3)
- colorator (~> 0.1)
- commander (~> 4.1.3)
- liquid (~> 2.5.2)
- listen (~> 1.3)
- maruku (~> 0.6.0)
- pygments.rb (~> 0.5.0)
- redcarpet (~> 2.3.0)
- safe_yaml (~> 1.0.4)
- kramdown (1.2.0)
- liquid (2.5.4)
- listen (1.3.1)
- rb-fsevent (>= 0.9.3)
- rb-inotify (>= 0.9)
- rb-kqueue (>= 0.2)
- maruku (0.6.1)
- syntax (>= 1.0.0)
- posix-spawn (0.3.6)
- pygments.rb (0.5.4)
- posix-spawn (~> 0.3.6)
- yajl-ruby (~> 1.1.0)
- rb-fsevent (0.9.3)
- rb-inotify (0.9.2)
- ffi (>= 0.5.0)
- rb-kqueue (0.2.0)
- ffi (>= 0.5.0)
- rdiscount (2.1.7)
- redcarpet (2.3.0)
- safe_yaml (1.0.4)
- syntax (1.0.0)
- yajl-ruby (1.1.0)
+ activesupport (7.2.1)
+ base64
+ bigdecimal
+ concurrent-ruby (~> 1.0, >= 1.3.1)
+ connection_pool (>= 2.2.5)
+ drb
+ i18n (>= 1.6, < 2)
+ logger (>= 1.4.2)
+ minitest (>= 5.1)
+ securerandom (>= 0.3)
+ tzinfo (~> 2.0, >= 2.0.5)
+ addressable (2.8.7)
+ public_suffix (>= 2.0.2, < 7.0)
+ base64 (0.2.0)
+ bigdecimal (3.1.8)
+ coffee-script (2.4.1)
+ coffee-script-source
+ execjs
+ coffee-script-source (1.12.2)
+ colorator (1.1.0)
+ commonmarker (0.23.10)
+ concurrent-ruby (1.3.4)
+ connection_pool (2.4.1)
+ dnsruby (1.72.2)
+ simpleidn (~> 0.2.1)
+ drb (2.2.1)
+ em-websocket (0.5.3)
+ eventmachine (>= 0.12.9)
+ http_parser.rb (~> 0)
+ ethon (0.16.0)
+ ffi (>= 1.15.0)
+ eventmachine (1.2.7)
+ execjs (2.9.1)
+ faraday (2.12.0)
+ faraday-net_http (>= 2.0, < 3.4)
+ json
+ logger
+ faraday-net_http (3.3.0)
+ net-http
+ ffi (1.17.0)
+ ffi (1.17.0-arm64-darwin)
+ ffi (1.17.0-x86_64-linux-gnu)
+ forwardable-extended (2.6.0)
+ gemoji (4.1.0)
+ github-pages (231)
+ github-pages-health-check (= 1.18.2)
+ jekyll (= 3.9.5)
+ jekyll-avatar (= 0.8.0)
+ jekyll-coffeescript (= 1.2.2)
+ jekyll-commonmark-ghpages (= 0.4.0)
+ jekyll-default-layout (= 0.1.5)
+ jekyll-feed (= 0.17.0)
+ jekyll-gist (= 1.5.0)
+ jekyll-github-metadata (= 2.16.1)
+ jekyll-include-cache (= 0.2.1)
+ jekyll-mentions (= 1.6.0)
+ jekyll-optional-front-matter (= 0.3.2)
+ jekyll-paginate (= 1.1.0)
+ jekyll-readme-index (= 0.3.0)
+ jekyll-redirect-from (= 0.16.0)
+ jekyll-relative-links (= 0.6.1)
+ jekyll-remote-theme (= 0.4.3)
+ jekyll-sass-converter (= 1.5.2)
+ jekyll-seo-tag (= 2.8.0)
+ jekyll-sitemap (= 1.4.0)
+ jekyll-swiss (= 1.0.0)
+ jekyll-theme-architect (= 0.2.0)
+ jekyll-theme-cayman (= 0.2.0)
+ jekyll-theme-dinky (= 0.2.0)
+ jekyll-theme-hacker (= 0.2.0)
+ jekyll-theme-leap-day (= 0.2.0)
+ jekyll-theme-merlot (= 0.2.0)
+ jekyll-theme-midnight (= 0.2.0)
+ jekyll-theme-minimal (= 0.2.0)
+ jekyll-theme-modernist (= 0.2.0)
+ jekyll-theme-primer (= 0.6.0)
+ jekyll-theme-slate (= 0.2.0)
+ jekyll-theme-tactile (= 0.2.0)
+ jekyll-theme-time-machine (= 0.2.0)
+ jekyll-titles-from-headings (= 0.5.3)
+ jemoji (= 0.13.0)
+ kramdown (= 2.4.0)
+ kramdown-parser-gfm (= 1.1.0)
+ liquid (= 4.0.4)
+ mercenary (~> 0.3)
+ minima (= 2.5.1)
+ nokogiri (>= 1.13.6, < 2.0)
+ rouge (= 3.30.0)
+ terminal-table (~> 1.4)
+ github-pages-health-check (1.18.2)
+ addressable (~> 2.3)
+ dnsruby (~> 1.60)
+ octokit (>= 4, < 8)
+ public_suffix (>= 3.0, < 6.0)
+ typhoeus (~> 1.3)
+ html-pipeline (2.14.3)
+ activesupport (>= 2)
+ nokogiri (>= 1.4)
+ http_parser.rb (0.8.0)
+ i18n (1.14.6)
+ concurrent-ruby (~> 1.0)
+ jekyll (3.9.5)
+ addressable (~> 2.4)
+ colorator (~> 1.0)
+ em-websocket (~> 0.5)
+ i18n (>= 0.7, < 2)
+ jekyll-sass-converter (~> 1.0)
+ jekyll-watch (~> 2.0)
+ kramdown (>= 1.17, < 3)
+ liquid (~> 4.0)
+ mercenary (~> 0.3.3)
+ pathutil (~> 0.9)
+ rouge (>= 1.7, < 4)
+ safe_yaml (~> 1.0)
+ jekyll-avatar (0.8.0)
+ jekyll (>= 3.0, < 5.0)
+ jekyll-coffeescript (1.2.2)
+ coffee-script (~> 2.2)
+ coffee-script-source (~> 1.12)
+ jekyll-commonmark (1.4.0)
+ commonmarker (~> 0.22)
+ jekyll-commonmark-ghpages (0.4.0)
+ commonmarker (~> 0.23.7)
+ jekyll (~> 3.9.0)
+ jekyll-commonmark (~> 1.4.0)
+ rouge (>= 2.0, < 5.0)
+ jekyll-default-layout (0.1.5)
+ jekyll (>= 3.0, < 5.0)
+ jekyll-feed (0.17.0)
+ jekyll (>= 3.7, < 5.0)
+ jekyll-gist (1.5.0)
+ octokit (~> 4.2)
+ jekyll-github-metadata (2.16.1)
+ jekyll (>= 3.4, < 5.0)
+ octokit (>= 4, < 7, != 4.4.0)
+ jekyll-include-cache (0.2.1)
+ jekyll (>= 3.7, < 5.0)
+ jekyll-mentions (1.6.0)
+ html-pipeline (~> 2.3)
+ jekyll (>= 3.7, < 5.0)
+ jekyll-optional-front-matter (0.3.2)
+ jekyll (>= 3.0, < 5.0)
+ jekyll-paginate (1.1.0)
+ jekyll-readme-index (0.3.0)
+ jekyll (>= 3.0, < 5.0)
+ jekyll-redirect-from (0.16.0)
+ jekyll (>= 3.3, < 5.0)
+ jekyll-relative-links (0.6.1)
+ jekyll (>= 3.3, < 5.0)
+ jekyll-remote-theme (0.4.3)
+ addressable (~> 2.0)
+ jekyll (>= 3.5, < 5.0)
+ jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
+ rubyzip (>= 1.3.0, < 3.0)
+ jekyll-sass-converter (1.5.2)
+ sass (~> 3.4)
+ jekyll-seo-tag (2.8.0)
+ jekyll (>= 3.8, < 5.0)
+ jekyll-sitemap (1.4.0)
+ jekyll (>= 3.7, < 5.0)
+ jekyll-swiss (1.0.0)
+ jekyll-theme-architect (0.2.0)
+ jekyll (> 3.5, < 5.0)
+ jekyll-seo-tag (~> 2.0)
+ jekyll-theme-cayman (0.2.0)
+ jekyll (> 3.5, < 5.0)
+ jekyll-seo-tag (~> 2.0)
+ jekyll-theme-dinky (0.2.0)
+ jekyll (> 3.5, < 5.0)
+ jekyll-seo-tag (~> 2.0)
+ jekyll-theme-hacker (0.2.0)
+ jekyll (> 3.5, < 5.0)
+ jekyll-seo-tag (~> 2.0)
+ jekyll-theme-leap-day (0.2.0)
+ jekyll (> 3.5, < 5.0)
+ jekyll-seo-tag (~> 2.0)
+ jekyll-theme-merlot (0.2.0)
+ jekyll (> 3.5, < 5.0)
+ jekyll-seo-tag (~> 2.0)
+ jekyll-theme-midnight (0.2.0)
+ jekyll (> 3.5, < 5.0)
+ jekyll-seo-tag (~> 2.0)
+ jekyll-theme-minimal (0.2.0)
+ jekyll (> 3.5, < 5.0)
+ jekyll-seo-tag (~> 2.0)
+ jekyll-theme-modernist (0.2.0)
+ jekyll (> 3.5, < 5.0)
+ jekyll-seo-tag (~> 2.0)
+ jekyll-theme-primer (0.6.0)
+ jekyll (> 3.5, < 5.0)
+ jekyll-github-metadata (~> 2.9)
+ jekyll-seo-tag (~> 2.0)
+ jekyll-theme-slate (0.2.0)
+ jekyll (> 3.5, < 5.0)
+ jekyll-seo-tag (~> 2.0)
+ jekyll-theme-tactile (0.2.0)
+ jekyll (> 3.5, < 5.0)
+ jekyll-seo-tag (~> 2.0)
+ jekyll-theme-time-machine (0.2.0)
+ jekyll (> 3.5, < 5.0)
+ jekyll-seo-tag (~> 2.0)
+ jekyll-titles-from-headings (0.5.3)
+ jekyll (>= 3.3, < 5.0)
+ jekyll-twitter-plugin (2.1.0)
+ jekyll-watch (2.2.1)
+ listen (~> 3.0)
+ jemoji (0.13.0)
+ gemoji (>= 3, < 5)
+ html-pipeline (~> 2.2)
+ jekyll (>= 3.0, < 5.0)
+ json (2.7.2)
+ kramdown (2.4.0)
+ rexml
+ kramdown-parser-gfm (1.1.0)
+ kramdown (~> 2.0)
+ liquid (4.0.4)
+ listen (3.9.0)
+ rb-fsevent (~> 0.10, >= 0.10.3)
+ rb-inotify (~> 0.9, >= 0.9.10)
+ logger (1.6.1)
+ mercenary (0.3.6)
+ mini_portile2 (2.8.4)
+ minima (2.5.1)
+ jekyll (>= 3.5, < 5.0)
+ jekyll-feed (~> 0.9)
+ jekyll-seo-tag (~> 2.1)
+ minitest (5.25.1)
+ net-http (0.4.1)
+ uri
+ nokogiri (1.15.4)
+ mini_portile2 (~> 2.8.2)
+ racc (~> 1.4)
+ octokit (4.25.1)
+ faraday (>= 1, < 3)
+ sawyer (~> 0.9)
+ pathutil (0.16.2)
+ forwardable-extended (~> 2.6)
+ public_suffix (5.1.1)
+ racc (1.8.1)
+ rb-fsevent (0.11.2)
+ rb-inotify (0.11.1)
+ ffi (~> 1.0)
+ redcarpet (3.6.0)
+ rexml (3.3.8)
+ rouge (3.30.0)
+ rubyzip (2.3.2)
+ safe_yaml (1.0.5)
+ sass (3.7.4)
+ sass-listen (~> 4.0.0)
+ sass-listen (4.0.0)
+ rb-fsevent (~> 0.9, >= 0.9.4)
+ rb-inotify (~> 0.9, >= 0.9.7)
+ sawyer (0.9.2)
+ addressable (>= 2.3.5)
+ faraday (>= 0.17.3, < 3)
+ securerandom (0.3.1)
+ simpleidn (0.2.3)
+ terminal-table (1.8.0)
+ unicode-display_width (~> 1.1, >= 1.1.1)
+ typhoeus (1.4.1)
+ ethon (>= 0.9.0)
+ tzinfo (2.0.6)
+ concurrent-ruby (~> 1.0)
+ unicode-display_width (1.8.0)
+ uri (0.13.1)
+ webrick (1.8.2)
PLATFORMS
+ arm64-darwin
ruby
+ x86_64-linux
DEPENDENCIES
github-pages
+ jekyll-twitter-plugin
+ mini_portile2 (= 2.8.4)
+ nokogiri (= 1.15.4)
+ redcarpet
+ webrick (~> 1.8)
BUNDLED WITH
- 1.10.4
+ 2.5.16
diff --git a/docs/README.md b/docs/README.md
index c9646e1295..1f67945f04 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -46,8 +46,8 @@ docker run --rm -it \
-v $PWD:/docs \
-w /docs \
-p '4000:4000' \
- ruby:2.0.0 \
- bash -c "bundle install && bundle exec jekyll serve --watch"
+ ruby:3.3.5 \
+ bash -c "bundle install && bundle exec jekyll serve --watch --host
0.0.0.0"
```
Using the above command, Jekyll will start a web server at
`http://localhost:4000` and watch the `/docs` directory for updates.
diff --git a/docs/_config.yml b/docs/_config.yml
index af2eaf85b8..904614dec6 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -3,7 +3,7 @@
permalink: /:categories/:year/:month/:day/:title
exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md",
"vendor", "node_modules", "scss"]
-pygments: true
+highlighter: rouge
markdown: redcarpet
redcarpet:
extensions: ["tables"]
diff --git a/docs/_includes/JB/setup b/docs/_includes/JB/setup
index efcd84b002..41d38bb863 100644
--- a/docs/_includes/JB/setup
+++ b/docs/_includes/JB/setup
@@ -16,7 +16,7 @@
{% if site.JB.ASSET_PATH %}
{% assign ASSET_PATH = site.JB.ASSET_PATH %}
{% else %}
- {% capture ASSET_PATH %}{{ BASE_PATH }}/assets/themes/{{ page.theme.name
}}{% endcapture %}
+ {% capture ASSET_PATH %}{{ BASE_PATH }}/assets/themes/{% if
page.theme.name %}{{ page.theme.name }}{% else if %}{{ layout.theme.name }}{%
endif %}{% endcapture %}
{% endif %}
{% endif %}
-{% endcapture %}{% assign jbcache = nil %}
\ No newline at end of file
+{% endcapture %}{% assign jbcache = nil %}
