Skip to content

Commit fd1e6b2

Browse files
slinkydeveloperslinkydeveloper
authored
Improved a bit the docs website (#185)
* Improved a bit the docs Changed the docs website theme Signed-off-by: Francesco Guardiani <francescoguard@gmail.com> * Using constants Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
1 parent 12cca34 commit fd1e6b2

File tree

8 files changed

+380
-12
lines changed

8 files changed

+380
-12
lines changed

‎.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,9 @@ release.properties
3434

3535
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
3636
hs_err_pid*
37+
38+
# Jekyll stuff
39+
_site/
40+
.sass-cache/
41+
.jekyll-cache/
42+
.jekyll-metadata

‎README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
A Java API for the [CloudEvents specification](https://github.com/cloudevents/spec)
99

10+
Look at https://cloudevents.github.io/sdk-java/ for more documentation.
11+
1012
__Checkout the [changelog](./CHANGELOG.md)__
1113

1214
## Status

‎core/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,11 @@ add `cloudevents-json-jackson` as a dependency and then:
4141

4242
```java
4343
import io.cloudevents.core.format.EventFormatProvider;
44+
import io.cloudevents.jackson.JsonFormat;
4445

45-
EventFormat format = EventFormatProvider.getInstance().resolveFormat("application/json");
46+
EventFormat format = EventFormatProvider
47+
.getInstance()
48+
.resolveFormat(JsonFormat.CONTENT_TYPE);
4649

4750
// Serialize event
4851
byte[] serialized = format.serialize(event);

‎docs/Gemfile

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
source "https://rubygems.org"
2+
# Hello! This is where you manage which Jekyll version is used to run.
3+
# When you want to use a different version, change it below, save the
4+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
5+
#
6+
# bundle exec jekyll serve
7+
#
8+
# This will help ensure the proper Jekyll version is running.
9+
# Happy Jekylling!
10+
11+
gem "jekyll", "~> 3.8.7"
12+
gem "github-pages", group: :jekyll_plugins
13+
14+
gem "just-the-docs"
15+
16+
# If you have any plugins, put them here!
17+
group :jekyll_plugins do
18+
gem "jekyll-feed", "~> 0.13"
19+
end
20+
21+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
22+
# and associated library.
23+
install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
24+
gem "tzinfo", "~> 1.2"
25+
gem "tzinfo-data"
26+
end
27+
28+
# Performance-booster for watching directories on Windows
29+
gem "wdm", "~> 0.1.1", :install_if => Gem.win_platform?
30+

‎docs/Gemfile.lock

Lines changed: 262 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,262 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (6.0.3.2)
5+
concurrent-ruby (~> 1.0, >= 1.0.2)
6+
i18n (>= 0.7, < 2)
7+
minitest (~> 5.1)
8+
tzinfo (~> 1.1)
9+
zeitwerk (~> 2.2, >= 2.2.2)
10+
addressable (2.7.0)
11+
public_suffix (>= 2.0.2, < 5.0)
12+
coffee-script (2.4.1)
13+
coffee-script-source
14+
execjs
15+
coffee-script-source (1.11.1)
16+
colorator (1.1.0)
17+
commonmarker (0.17.13)
18+
ruby-enum (~> 0.5)
19+
concurrent-ruby (1.1.6)
20+
dnsruby (1.61.3)
21+
addressable (~> 2.5)
22+
em-websocket (0.5.1)
23+
eventmachine (>= 0.12.9)
24+
http_parser.rb (~> 0.6.0)
25+
ethon (0.12.0)
26+
ffi (>= 1.3.0)
27+
eventmachine (1.2.7)
28+
execjs (2.7.0)
29+
faraday (1.0.1)
30+
multipart-post (>= 1.2, < 3)
31+
ffi (1.13.1)
32+
forwardable-extended (2.6.0)
33+
gemoji (3.0.1)
34+
github-pages (206)
35+
github-pages-health-check (= 1.16.1)
36+
jekyll (= 3.8.7)
37+
jekyll-avatar (= 0.7.0)
38+
jekyll-coffeescript (= 1.1.1)
39+
jekyll-commonmark-ghpages (= 0.1.6)
40+
jekyll-default-layout (= 0.1.4)
41+
jekyll-feed (= 0.13.0)
42+
jekyll-gist (= 1.5.0)
43+
jekyll-github-metadata (= 2.13.0)
44+
jekyll-mentions (= 1.5.1)
45+
jekyll-optional-front-matter (= 0.3.2)
46+
jekyll-paginate (= 1.1.0)
47+
jekyll-readme-index (= 0.3.0)
48+
jekyll-redirect-from (= 0.15.0)
49+
jekyll-relative-links (= 0.6.1)
50+
jekyll-remote-theme (= 0.4.1)
51+
jekyll-sass-converter (= 1.5.2)
52+
jekyll-seo-tag (= 2.6.1)
53+
jekyll-sitemap (= 1.4.0)
54+
jekyll-swiss (= 1.0.0)
55+
jekyll-theme-architect (= 0.1.1)
56+
jekyll-theme-cayman (= 0.1.1)
57+
jekyll-theme-dinky (= 0.1.1)
58+
jekyll-theme-hacker (= 0.1.1)
59+
jekyll-theme-leap-day (= 0.1.1)
60+
jekyll-theme-merlot (= 0.1.1)
61+
jekyll-theme-midnight (= 0.1.1)
62+
jekyll-theme-minimal (= 0.1.1)
63+
jekyll-theme-modernist (= 0.1.1)
64+
jekyll-theme-primer (= 0.5.4)
65+
jekyll-theme-slate (= 0.1.1)
66+
jekyll-theme-tactile (= 0.1.1)
67+
jekyll-theme-time-machine (= 0.1.1)
68+
jekyll-titles-from-headings (= 0.5.3)
69+
jemoji (= 0.11.1)
70+
kramdown (= 1.17.0)
71+
liquid (= 4.0.3)
72+
mercenary (~> 0.3)
73+
minima (= 2.5.1)
74+
nokogiri (>= 1.10.4, < 2.0)
75+
rouge (= 3.19.0)
76+
terminal-table (~> 1.4)
77+
github-pages-health-check (1.16.1)
78+
addressable (~> 2.3)
79+
dnsruby (~> 1.60)
80+
octokit (~> 4.0)
81+
public_suffix (~> 3.0)
82+
typhoeus (~> 1.3)
83+
html-pipeline (2.13.0)
84+
activesupport (>= 2)
85+
nokogiri (>= 1.4)
86+
http_parser.rb (0.6.0)
87+
i18n (0.9.5)
88+
concurrent-ruby (~> 1.0)
89+
jekyll (3.8.7)
90+
addressable (~> 2.4)
91+
colorator (~> 1.0)
92+
em-websocket (~> 0.5)
93+
i18n (~> 0.7)
94+
jekyll-sass-converter (~> 1.0)
95+
jekyll-watch (~> 2.0)
96+
kramdown (~> 1.14)
97+
liquid (~> 4.0)
98+
mercenary (~> 0.3.3)
99+
pathutil (~> 0.9)
100+
rouge (>= 1.7, < 4)
101+
safe_yaml (~> 1.0)
102+
jekyll-avatar (0.7.0)
103+
jekyll (>= 3.0, < 5.0)
104+
jekyll-coffeescript (1.1.1)
105+
coffee-script (~> 2.2)
106+
coffee-script-source (~> 1.11.1)
107+
jekyll-commonmark (1.3.1)
108+
commonmarker (~> 0.14)
109+
jekyll (>= 3.7, < 5.0)
110+
jekyll-commonmark-ghpages (0.1.6)
111+
commonmarker (~> 0.17.6)
112+
jekyll-commonmark (~> 1.2)
113+
rouge (>= 2.0, < 4.0)
114+
jekyll-default-layout (0.1.4)
115+
jekyll (~> 3.0)
116+
jekyll-feed (0.13.0)
117+
jekyll (>= 3.7, < 5.0)
118+
jekyll-gist (1.5.0)
119+
octokit (~> 4.2)
120+
jekyll-github-metadata (2.13.0)
121+
jekyll (>= 3.4, < 5.0)
122+
octokit (~> 4.0, != 4.4.0)
123+
jekyll-mentions (1.5.1)
124+
html-pipeline (~> 2.3)
125+
jekyll (>= 3.7, < 5.0)
126+
jekyll-optional-front-matter (0.3.2)
127+
jekyll (>= 3.0, < 5.0)
128+
jekyll-paginate (1.1.0)
129+
jekyll-readme-index (0.3.0)
130+
jekyll (>= 3.0, < 5.0)
131+
jekyll-redirect-from (0.15.0)
132+
jekyll (>= 3.3, < 5.0)
133+
jekyll-relative-links (0.6.1)
134+
jekyll (>= 3.3, < 5.0)
135+
jekyll-remote-theme (0.4.1)
136+
addressable (~> 2.0)
137+
jekyll (>= 3.5, < 5.0)
138+
rubyzip (>= 1.3.0)
139+
jekyll-sass-converter (1.5.2)
140+
sass (~> 3.4)
141+
jekyll-seo-tag (2.6.1)
142+
jekyll (>= 3.3, < 5.0)
143+
jekyll-sitemap (1.4.0)
144+
jekyll (>= 3.7, < 5.0)
145+
jekyll-swiss (1.0.0)
146+
jekyll-theme-architect (0.1.1)
147+
jekyll (~> 3.5)
148+
jekyll-seo-tag (~> 2.0)
149+
jekyll-theme-cayman (0.1.1)
150+
jekyll (~> 3.5)
151+
jekyll-seo-tag (~> 2.0)
152+
jekyll-theme-dinky (0.1.1)
153+
jekyll (~> 3.5)
154+
jekyll-seo-tag (~> 2.0)
155+
jekyll-theme-hacker (0.1.1)
156+
jekyll (~> 3.5)
157+
jekyll-seo-tag (~> 2.0)
158+
jekyll-theme-leap-day (0.1.1)
159+
jekyll (~> 3.5)
160+
jekyll-seo-tag (~> 2.0)
161+
jekyll-theme-merlot (0.1.1)
162+
jekyll (~> 3.5)
163+
jekyll-seo-tag (~> 2.0)
164+
jekyll-theme-midnight (0.1.1)
165+
jekyll (~> 3.5)
166+
jekyll-seo-tag (~> 2.0)
167+
jekyll-theme-minimal (0.1.1)
168+
jekyll (~> 3.5)
169+
jekyll-seo-tag (~> 2.0)
170+
jekyll-theme-modernist (0.1.1)
171+
jekyll (~> 3.5)
172+
jekyll-seo-tag (~> 2.0)
173+
jekyll-theme-primer (0.5.4)
174+
jekyll (> 3.5, < 5.0)
175+
jekyll-github-metadata (~> 2.9)
176+
jekyll-seo-tag (~> 2.0)
177+
jekyll-theme-slate (0.1.1)
178+
jekyll (~> 3.5)
179+
jekyll-seo-tag (~> 2.0)
180+
jekyll-theme-tactile (0.1.1)
181+
jekyll (~> 3.5)
182+
jekyll-seo-tag (~> 2.0)
183+
jekyll-theme-time-machine (0.1.1)
184+
jekyll (~> 3.5)
185+
jekyll-seo-tag (~> 2.0)
186+
jekyll-titles-from-headings (0.5.3)
187+
jekyll (>= 3.3, < 5.0)
188+
jekyll-watch (2.2.1)
189+
listen (~> 3.0)
190+
jemoji (0.11.1)
191+
gemoji (~> 3.0)
192+
html-pipeline (~> 2.2)
193+
jekyll (>= 3.0, < 5.0)
194+
just-the-docs (0.2.9)
195+
jekyll (>= 3.8.5, < 4.1.0)
196+
jekyll-seo-tag (~> 2.0)
197+
rake (>= 12.3.1, < 13.1.0)
198+
kramdown (1.17.0)
199+
liquid (4.0.3)
200+
listen (3.2.1)
201+
rb-fsevent (~> 0.10, >= 0.10.3)
202+
rb-inotify (~> 0.9, >= 0.9.10)
203+
mercenary (0.3.6)
204+
mini_portile2 (2.4.0)
205+
minima (2.5.1)
206+
jekyll (>= 3.5, < 5.0)
207+
jekyll-feed (~> 0.9)
208+
jekyll-seo-tag (~> 2.1)
209+
minitest (5.14.1)
210+
multipart-post (2.1.1)
211+
nokogiri (1.10.9)
212+
mini_portile2 (~> 2.4.0)
213+
octokit (4.18.0)
214+
faraday (>= 0.9)
215+
sawyer (~> 0.8.0, >= 0.5.3)
216+
pathutil (0.16.2)
217+
forwardable-extended (~> 2.6)
218+
public_suffix (3.1.1)
219+
rake (13.0.1)
220+
rb-fsevent (0.10.4)
221+
rb-inotify (0.10.1)
222+
ffi (~> 1.0)
223+
rouge (3.19.0)
224+
ruby-enum (0.8.0)
225+
i18n
226+
rubyzip (2.3.0)
227+
safe_yaml (1.0.5)
228+
sass (3.7.4)
229+
sass-listen (~> 4.0.0)
230+
sass-listen (4.0.0)
231+
rb-fsevent (~> 0.9, >= 0.9.4)
232+
rb-inotify (~> 0.9, >= 0.9.7)
233+
sawyer (0.8.2)
234+
addressable (>= 2.3.5)
235+
faraday (> 0.8, < 2.0)
236+
terminal-table (1.8.0)
237+
unicode-display_width (~> 1.1, >= 1.1.1)
238+
thread_safe (0.3.6)
239+
typhoeus (1.4.0)
240+
ethon (>= 0.9.0)
241+
tzinfo (1.2.7)
242+
thread_safe (~> 0.1)
243+
tzinfo-data (1.2020.1)
244+
tzinfo (>= 1.0.0)
245+
unicode-display_width (1.7.0)
246+
wdm (0.1.1)
247+
zeitwerk (2.3.0)
248+
249+
PLATFORMS
250+
ruby
251+
252+
DEPENDENCIES
253+
github-pages
254+
jekyll (~> 3.8.7)
255+
jekyll-feed (~> 0.13)
256+
just-the-docs
257+
tzinfo (~> 1.2)
258+
tzinfo-data
259+
wdm (~> 0.1.1)
260+
261+
BUNDLED WITH
262+
2.1.4

‎docs/_config.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1-
theme: jekyll-theme-slate
1+
# To configure the environment locally to test the website, check out
2+
# https://help.github.com/en/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll
3+
4+
title: Java SDK for CloudEvents
5+
remote_theme: pmarsceill/just-the-docs
26
plugins:
37
- jemoji
8+
9+
aux_links:
10+
"GitHub Repository":
11+
- "https://github.com/cloudevents/sdk-java"
12+
"CloudEvents home":
13+
- "https://cloudevents.io/"

0 commit comments

Comments
 (0)