Skip to content

Commit aa5abd5

Browse files
tboneleetbonelee
authored
[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 <[email protected]>
1 parent 4aff03b commit aa5abd5

File tree

5 files changed

+285
-55
lines changed

5 files changed

+285
-55
lines changed

‎docs/Gemfile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,9 @@
1515
#
1616
source 'https://rubygems.org'
1717
gem 'github-pages'
18+
gem 'redcarpet'
19+
gem 'jekyll-twitter-plugin'
20+
gem 'nokogiri', '1.15.4'
21+
gem 'mini_portile2', '2.8.4'
22+
23+
gem "webrick", "~> 1.8" # By upgrading ruby to 3.x

‎docs/Gemfile.lock

Lines changed: 274 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,285 @@
11
GEM
22
remote: https://rubygems.org/
33
specs:
4-
RedCloth (4.2.9)
5-
classifier (1.3.3)
6-
fast-stemmer (>= 1.0.0)
7-
colorator (0.1)
8-
commander (4.1.5)
9-
highline (~> 1.6.11)
10-
fast-stemmer (1.0.2)
11-
ffi (1.9.3)
12-
github-pages (10)
13-
RedCloth (= 4.2.9)
14-
jekyll (= 1.3.0)
15-
kramdown (= 1.2.0)
16-
liquid (= 2.5.4)
17-
maruku (= 0.6.1)
18-
rdiscount (= 2.1.7)
19-
redcarpet (= 2.3.0)
20-
highline (1.6.20)
21-
jekyll (1.3.0)
22-
classifier (~> 1.3)
23-
colorator (~> 0.1)
24-
commander (~> 4.1.3)
25-
liquid (~> 2.5.2)
26-
listen (~> 1.3)
27-
maruku (~> 0.6.0)
28-
pygments.rb (~> 0.5.0)
29-
redcarpet (~> 2.3.0)
30-
safe_yaml (~> 1.0.4)
31-
kramdown (1.2.0)
32-
liquid (2.5.4)
33-
listen (1.3.1)
34-
rb-fsevent (>= 0.9.3)
35-
rb-inotify (>= 0.9)
36-
rb-kqueue (>= 0.2)
37-
maruku (0.6.1)
38-
syntax (>= 1.0.0)
39-
posix-spawn (0.3.6)
40-
pygments.rb (0.5.4)
41-
posix-spawn (~> 0.3.6)
42-
yajl-ruby (~> 1.1.0)
43-
rb-fsevent (0.9.3)
44-
rb-inotify (0.9.2)
45-
ffi (>= 0.5.0)
46-
rb-kqueue (0.2.0)
47-
ffi (>= 0.5.0)
48-
rdiscount (2.1.7)
49-
redcarpet (2.3.0)
50-
safe_yaml (1.0.4)
51-
syntax (1.0.0)
52-
yajl-ruby (1.1.0)
4+
activesupport (7.2.1)
5+
base64
6+
bigdecimal
7+
concurrent-ruby (~> 1.0, >= 1.3.1)
8+
connection_pool (>= 2.2.5)
9+
drb
10+
i18n (>= 1.6, < 2)
11+
logger (>= 1.4.2)
12+
minitest (>= 5.1)
13+
securerandom (>= 0.3)
14+
tzinfo (~> 2.0, >= 2.0.5)
15+
addressable (2.8.7)
16+
public_suffix (>= 2.0.2, < 7.0)
17+
base64 (0.2.0)
18+
bigdecimal (3.1.8)
19+
coffee-script (2.4.1)
20+
coffee-script-source
21+
execjs
22+
coffee-script-source (1.12.2)
23+
colorator (1.1.0)
24+
commonmarker (0.23.10)
25+
concurrent-ruby (1.3.4)
26+
connection_pool (2.4.1)
27+
dnsruby (1.72.2)
28+
simpleidn (~> 0.2.1)
29+
drb (2.2.1)
30+
em-websocket (0.5.3)
31+
eventmachine (>= 0.12.9)
32+
http_parser.rb (~> 0)
33+
ethon (0.16.0)
34+
ffi (>= 1.15.0)
35+
eventmachine (1.2.7)
36+
execjs (2.9.1)
37+
faraday (2.12.0)
38+
faraday-net_http (>= 2.0, < 3.4)
39+
json
40+
logger
41+
faraday-net_http (3.3.0)
42+
net-http
43+
ffi (1.17.0)
44+
ffi (1.17.0-arm64-darwin)
45+
ffi (1.17.0-x86_64-linux-gnu)
46+
forwardable-extended (2.6.0)
47+
gemoji (4.1.0)
48+
github-pages (231)
49+
github-pages-health-check (= 1.18.2)
50+
jekyll (= 3.9.5)
51+
jekyll-avatar (= 0.8.0)
52+
jekyll-coffeescript (= 1.2.2)
53+
jekyll-commonmark-ghpages (= 0.4.0)
54+
jekyll-default-layout (= 0.1.5)
55+
jekyll-feed (= 0.17.0)
56+
jekyll-gist (= 1.5.0)
57+
jekyll-github-metadata (= 2.16.1)
58+
jekyll-include-cache (= 0.2.1)
59+
jekyll-mentions (= 1.6.0)
60+
jekyll-optional-front-matter (= 0.3.2)
61+
jekyll-paginate (= 1.1.0)
62+
jekyll-readme-index (= 0.3.0)
63+
jekyll-redirect-from (= 0.16.0)
64+
jekyll-relative-links (= 0.6.1)
65+
jekyll-remote-theme (= 0.4.3)
66+
jekyll-sass-converter (= 1.5.2)
67+
jekyll-seo-tag (= 2.8.0)
68+
jekyll-sitemap (= 1.4.0)
69+
jekyll-swiss (= 1.0.0)
70+
jekyll-theme-architect (= 0.2.0)
71+
jekyll-theme-cayman (= 0.2.0)
72+
jekyll-theme-dinky (= 0.2.0)
73+
jekyll-theme-hacker (= 0.2.0)
74+
jekyll-theme-leap-day (= 0.2.0)
75+
jekyll-theme-merlot (= 0.2.0)
76+
jekyll-theme-midnight (= 0.2.0)
77+
jekyll-theme-minimal (= 0.2.0)
78+
jekyll-theme-modernist (= 0.2.0)
79+
jekyll-theme-primer (= 0.6.0)
80+
jekyll-theme-slate (= 0.2.0)
81+
jekyll-theme-tactile (= 0.2.0)
82+
jekyll-theme-time-machine (= 0.2.0)
83+
jekyll-titles-from-headings (= 0.5.3)
84+
jemoji (= 0.13.0)
85+
kramdown (= 2.4.0)
86+
kramdown-parser-gfm (= 1.1.0)
87+
liquid (= 4.0.4)
88+
mercenary (~> 0.3)
89+
minima (= 2.5.1)
90+
nokogiri (>= 1.13.6, < 2.0)
91+
rouge (= 3.30.0)
92+
terminal-table (~> 1.4)
93+
github-pages-health-check (1.18.2)
94+
addressable (~> 2.3)
95+
dnsruby (~> 1.60)
96+
octokit (>= 4, < 8)
97+
public_suffix (>= 3.0, < 6.0)
98+
typhoeus (~> 1.3)
99+
html-pipeline (2.14.3)
100+
activesupport (>= 2)
101+
nokogiri (>= 1.4)
102+
http_parser.rb (0.8.0)
103+
i18n (1.14.6)
104+
concurrent-ruby (~> 1.0)
105+
jekyll (3.9.5)
106+
addressable (~> 2.4)
107+
colorator (~> 1.0)
108+
em-websocket (~> 0.5)
109+
i18n (>= 0.7, < 2)
110+
jekyll-sass-converter (~> 1.0)
111+
jekyll-watch (~> 2.0)
112+
kramdown (>= 1.17, < 3)
113+
liquid (~> 4.0)
114+
mercenary (~> 0.3.3)
115+
pathutil (~> 0.9)
116+
rouge (>= 1.7, < 4)
117+
safe_yaml (~> 1.0)
118+
jekyll-avatar (0.8.0)
119+
jekyll (>= 3.0, < 5.0)
120+
jekyll-coffeescript (1.2.2)
121+
coffee-script (~> 2.2)
122+
coffee-script-source (~> 1.12)
123+
jekyll-commonmark (1.4.0)
124+
commonmarker (~> 0.22)
125+
jekyll-commonmark-ghpages (0.4.0)
126+
commonmarker (~> 0.23.7)
127+
jekyll (~> 3.9.0)
128+
jekyll-commonmark (~> 1.4.0)
129+
rouge (>= 2.0, < 5.0)
130+
jekyll-default-layout (0.1.5)
131+
jekyll (>= 3.0, < 5.0)
132+
jekyll-feed (0.17.0)
133+
jekyll (>= 3.7, < 5.0)
134+
jekyll-gist (1.5.0)
135+
octokit (~> 4.2)
136+
jekyll-github-metadata (2.16.1)
137+
jekyll (>= 3.4, < 5.0)
138+
octokit (>= 4, < 7, != 4.4.0)
139+
jekyll-include-cache (0.2.1)
140+
jekyll (>= 3.7, < 5.0)
141+
jekyll-mentions (1.6.0)
142+
html-pipeline (~> 2.3)
143+
jekyll (>= 3.7, < 5.0)
144+
jekyll-optional-front-matter (0.3.2)
145+
jekyll (>= 3.0, < 5.0)
146+
jekyll-paginate (1.1.0)
147+
jekyll-readme-index (0.3.0)
148+
jekyll (>= 3.0, < 5.0)
149+
jekyll-redirect-from (0.16.0)
150+
jekyll (>= 3.3, < 5.0)
151+
jekyll-relative-links (0.6.1)
152+
jekyll (>= 3.3, < 5.0)
153+
jekyll-remote-theme (0.4.3)
154+
addressable (~> 2.0)
155+
jekyll (>= 3.5, < 5.0)
156+
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
157+
rubyzip (>= 1.3.0, < 3.0)
158+
jekyll-sass-converter (1.5.2)
159+
sass (~> 3.4)
160+
jekyll-seo-tag (2.8.0)
161+
jekyll (>= 3.8, < 5.0)
162+
jekyll-sitemap (1.4.0)
163+
jekyll (>= 3.7, < 5.0)
164+
jekyll-swiss (1.0.0)
165+
jekyll-theme-architect (0.2.0)
166+
jekyll (> 3.5, < 5.0)
167+
jekyll-seo-tag (~> 2.0)
168+
jekyll-theme-cayman (0.2.0)
169+
jekyll (> 3.5, < 5.0)
170+
jekyll-seo-tag (~> 2.0)
171+
jekyll-theme-dinky (0.2.0)
172+
jekyll (> 3.5, < 5.0)
173+
jekyll-seo-tag (~> 2.0)
174+
jekyll-theme-hacker (0.2.0)
175+
jekyll (> 3.5, < 5.0)
176+
jekyll-seo-tag (~> 2.0)
177+
jekyll-theme-leap-day (0.2.0)
178+
jekyll (> 3.5, < 5.0)
179+
jekyll-seo-tag (~> 2.0)
180+
jekyll-theme-merlot (0.2.0)
181+
jekyll (> 3.5, < 5.0)
182+
jekyll-seo-tag (~> 2.0)
183+
jekyll-theme-midnight (0.2.0)
184+
jekyll (> 3.5, < 5.0)
185+
jekyll-seo-tag (~> 2.0)
186+
jekyll-theme-minimal (0.2.0)
187+
jekyll (> 3.5, < 5.0)
188+
jekyll-seo-tag (~> 2.0)
189+
jekyll-theme-modernist (0.2.0)
190+
jekyll (> 3.5, < 5.0)
191+
jekyll-seo-tag (~> 2.0)
192+
jekyll-theme-primer (0.6.0)
193+
jekyll (> 3.5, < 5.0)
194+
jekyll-github-metadata (~> 2.9)
195+
jekyll-seo-tag (~> 2.0)
196+
jekyll-theme-slate (0.2.0)
197+
jekyll (> 3.5, < 5.0)
198+
jekyll-seo-tag (~> 2.0)
199+
jekyll-theme-tactile (0.2.0)
200+
jekyll (> 3.5, < 5.0)
201+
jekyll-seo-tag (~> 2.0)
202+
jekyll-theme-time-machine (0.2.0)
203+
jekyll (> 3.5, < 5.0)
204+
jekyll-seo-tag (~> 2.0)
205+
jekyll-titles-from-headings (0.5.3)
206+
jekyll (>= 3.3, < 5.0)
207+
jekyll-twitter-plugin (2.1.0)
208+
jekyll-watch (2.2.1)
209+
listen (~> 3.0)
210+
jemoji (0.13.0)
211+
gemoji (>= 3, < 5)
212+
html-pipeline (~> 2.2)
213+
jekyll (>= 3.0, < 5.0)
214+
json (2.7.2)
215+
kramdown (2.4.0)
216+
rexml
217+
kramdown-parser-gfm (1.1.0)
218+
kramdown (~> 2.0)
219+
liquid (4.0.4)
220+
listen (3.9.0)
221+
rb-fsevent (~> 0.10, >= 0.10.3)
222+
rb-inotify (~> 0.9, >= 0.9.10)
223+
logger (1.6.1)
224+
mercenary (0.3.6)
225+
mini_portile2 (2.8.4)
226+
minima (2.5.1)
227+
jekyll (>= 3.5, < 5.0)
228+
jekyll-feed (~> 0.9)
229+
jekyll-seo-tag (~> 2.1)
230+
minitest (5.25.1)
231+
net-http (0.4.1)
232+
uri
233+
nokogiri (1.15.4)
234+
mini_portile2 (~> 2.8.2)
235+
racc (~> 1.4)
236+
octokit (4.25.1)
237+
faraday (>= 1, < 3)
238+
sawyer (~> 0.9)
239+
pathutil (0.16.2)
240+
forwardable-extended (~> 2.6)
241+
public_suffix (5.1.1)
242+
racc (1.8.1)
243+
rb-fsevent (0.11.2)
244+
rb-inotify (0.11.1)
245+
ffi (~> 1.0)
246+
redcarpet (3.6.0)
247+
rexml (3.3.8)
248+
rouge (3.30.0)
249+
rubyzip (2.3.2)
250+
safe_yaml (1.0.5)
251+
sass (3.7.4)
252+
sass-listen (~> 4.0.0)
253+
sass-listen (4.0.0)
254+
rb-fsevent (~> 0.9, >= 0.9.4)
255+
rb-inotify (~> 0.9, >= 0.9.7)
256+
sawyer (0.9.2)
257+
addressable (>= 2.3.5)
258+
faraday (>= 0.17.3, < 3)
259+
securerandom (0.3.1)
260+
simpleidn (0.2.3)
261+
terminal-table (1.8.0)
262+
unicode-display_width (~> 1.1, >= 1.1.1)
263+
typhoeus (1.4.1)
264+
ethon (>= 0.9.0)
265+
tzinfo (2.0.6)
266+
concurrent-ruby (~> 1.0)
267+
unicode-display_width (1.8.0)
268+
uri (0.13.1)
269+
webrick (1.8.2)
53270

54271
PLATFORMS
272+
arm64-darwin
55273
ruby
274+
x86_64-linux
56275

57276
DEPENDENCIES
58277
github-pages
278+
jekyll-twitter-plugin
279+
mini_portile2 (= 2.8.4)
280+
nokogiri (= 1.15.4)
281+
redcarpet
282+
webrick (~> 1.8)
59283

60284
BUNDLED WITH
61-
1.10.4
285+
2.5.16

‎docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ docker run --rm -it \
4646
-v $PWD:/docs \
4747
-w /docs \
4848
-p '4000:4000' \
49-
ruby:2.0.0 \
50-
bash -c "bundle install && bundle exec jekyll serve --watch"
49+
ruby:3.3.5 \
50+
bash -c "bundle install && bundle exec jekyll serve --watch --host 0.0.0.0"
5151
```
5252

5353
Using the above command, Jekyll will start a web server at `http://localhost:4000` and watch the `/docs` directory for updates.

‎docs/_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
permalink: /:categories/:year/:month/:day/:title
44

55
exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md", "vendor", "node_modules", "scss"]
6-
pygments: true
6+
highlighter: rouge
77
markdown: redcarpet
88
redcarpet:
99
extensions: ["tables"]

‎docs/_includes/JB/setup

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
{% if site.JB.ASSET_PATH %}
1717
{% assign ASSET_PATH = site.JB.ASSET_PATH %}
1818
{% else %}
19-
{% capture ASSET_PATH %}{{ BASE_PATH }}/assets/themes/{{ page.theme.name }}{% endcapture %}
19+
{% capture ASSET_PATH %}{{ BASE_PATH }}/assets/themes/{% if page.theme.name %}{{ page.theme.name }}{% else if %}{{ layout.theme.name }}{% endif %}{% endcapture %}
2020
{% endif %}
2121
{% endif %}
22-
{% endcapture %}{% assign jbcache = nil %}
22+
{% endcapture %}{% assign jbcache = nil %}

0 commit comments

Comments
 (0)