Skip to content

Commit b8d0304

Browse files
JingsongLiJingsongLi
authored
[FLINK-26744] Init document for table store and introduce quickstart
This closes apache#53
1 parent 210e96f commit b8d0304

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+5258
-0
lines changed

‎.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "docs/themes/book"]
2+
path = docs/themes/book
3+
url = https://github.com/alex-shpak/hugo-book

‎docs/.gitignore

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.bundle/
2+
.jekyll-metadata
3+
.jekyll-cache/
4+
.rubydeps/
5+
ruby2/.bundle/
6+
ruby2/.rubydeps/
7+
public/
8+
resources/
9+
.hugo_build.lock
10+
.DS_Store

‎docs/README.md

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
This README gives an overview of how to build and contribute to the
2+
documentation of Flink Table Store.
3+
4+
The documentation is included with the source of Flink Table Store in order to ensure
5+
that you always have docs corresponding to your checked-out version.
6+
7+
# Requirements
8+
9+
### Build the site locally
10+
11+
Make sure you have installed
12+
[Hugo](https://gohugo.io/getting-started/installing/) on your system.
13+
14+
From this directory:
15+
16+
* Fetch the theme submodule
17+
```sh
18+
git submodule update --init --recursive
19+
```
20+
* Start local server
21+
```sh
22+
hugo -b "" serve
23+
```
24+
25+
The site can be viewed at http://localhost:1313/
26+
27+
# Contribute
28+
29+
## Markdown
30+
31+
The documentation pages are written in
32+
[Markdown](http://daringfireball.net/projects/markdown/syntax). It is possible
33+
to use [GitHub flavored
34+
syntax](http://github.github.com/github-flavored-markdown) and intermix plain
35+
html.
36+
37+
## Front matter
38+
39+
In addition to Markdown, every page contains a Jekyll front matter, which
40+
specifies the title of the page and the layout to use. The title is used as the
41+
top-level heading for the page.
42+
43+
---
44+
title: "Title of the Page"
45+
---
46+
47+
---
48+
title: "Title of the Page" <-- Title rendered in the side nav
49+
weight: 1 <-- Weight controls the ordering of pages in the side nav
50+
type: docs <-- required
51+
aliases: <-- Alias to setup redirect from removed page to this one
52+
- /alias/to/removed/page.html
53+
---
54+
55+
## Structure
56+
57+
### Page
58+
59+
#### Headings
60+
61+
All documents are structured with headings. From these headings, you can
62+
automatically generate a page table of contents (see below).
63+
64+
```
65+
# Level-1 Heading <- Used for the title of the page
66+
## Level-2 Heading <- Start with this one for content
67+
### Level-3 heading
68+
#### Level-4 heading
69+
##### Level-5 heading
70+
```
71+
72+
Please stick to the "logical order" when using the headlines, e.g. start with
73+
level-2 headings and use level-3 headings for subsections, etc. Don't use a
74+
different ordering, because you don't like how a headline looks.
75+
76+
#### Table of Contents
77+
78+
Table of contents are added automatically to every page, based on heading levels
79+
2 - 4. The ToC can be omitted by adding the following to the front matter of
80+
the page:
81+
82+
---
83+
bookToc: false
84+
---
85+
86+
### ShortCodes
87+
88+
Flink Table Store uses [shortcodes](https://gohugo.io/content-management/shortcodes/) to add
89+
custom functionality to its documentation markdown.
90+
91+
Its implementation and documentation can be found at
92+
`./layouts/shortcodes/artifact.html`. Please refer to `./layouts/shortcodes/`
93+
for other shortcodes available.

‎docs/assets/_custom.scss

+239
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,239 @@
1+
// Licensed to the Apache Software Foundation (ASF) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The ASF licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
18+
@import "github";
19+
20+
.link {
21+
padding-bottom: 5px;
22+
}
23+
24+
.appetizer {
25+
color: #FBB142;
26+
}
27+
28+
.maindish {
29+
color: #7E4F89;
30+
}
31+
32+
.dessert {
33+
color: #E6526F;
34+
}
35+
36+
.book-menu nav {
37+
background: #f8f8f8;
38+
}
39+
40+
.book-page {
41+
padding: 2rem 2rem;
42+
}
43+
44+
.book-search input {
45+
background: white;
46+
}
47+
48+
.markdown a {
49+
text-decoration: none;
50+
color: #05b;
51+
}
52+
53+
.markdown a:visited {
54+
text-decoration: none;
55+
color: #05b;
56+
}
57+
58+
.markdown {
59+
line-height: 1.43;
60+
61+
h1,
62+
h2,
63+
h3,
64+
h4,
65+
h5,
66+
h6 {
67+
font-weight: 500;
68+
padding-top: 0;
69+
margin-top: 1em;
70+
}
71+
}
72+
73+
body {
74+
letter-spacing: normal;
75+
-webkit-font-smoothing: auto;
76+
}
77+
78+
aside nav ul {
79+
li {
80+
margin: 0.5em 0;
81+
}
82+
}
83+
84+
.book-search {
85+
border: 2px solid #ebebeb;
86+
}
87+
88+
@media screen and (max-width: 768px) {
89+
.toc {
90+
display: none;
91+
}
92+
}
93+
94+
aside.book-menu nav {
95+
a:hover {
96+
font-weight: bold;
97+
opacity: 1.0;
98+
}
99+
100+
a.active {
101+
font-weight: bold;
102+
color: var(--body-font-color);
103+
}
104+
}
105+
106+
aside.book-menu > li {
107+
padding: 10px 5px 5px 5px;
108+
}
109+
110+
aside.book-toc {
111+
h3 {
112+
margin-top: 0;
113+
padding-top: 0;
114+
font-size: 1.2em;
115+
}
116+
}
117+
118+
html {
119+
line-height: 1.43;
120+
}
121+
122+
h1, h2, h3, h4, h5, h6 {
123+
line-height: 1.1;
124+
}
125+
126+
h1, h2, h3 {
127+
margin-top: 20px;
128+
margin-bottom: 10px;
129+
}
130+
131+
h2, h3, h4 {
132+
padding-top: 1em;
133+
}
134+
135+
h1 {
136+
font-size: 36px;
137+
}
138+
139+
h2 {
140+
font-size: 30px;
141+
border-bottom: 1px solid #e5e5e5;
142+
}
143+
144+
h3 {
145+
font-size: 24px;
146+
}
147+
148+
h4 {
149+
font-size: 18px;
150+
}
151+
152+
.markdown code {
153+
background: white;
154+
padding: 0;
155+
border-radius: 0;
156+
}
157+
158+
pre.chroma code {
159+
line-height: 1.43;
160+
}
161+
162+
.book-languages {
163+
border: 2px solid black;
164+
}
165+
166+
.menu-break {
167+
opacity: 0.1;
168+
}
169+
170+
#book-search-results {
171+
padding: 2px;
172+
background-color: white;
173+
}
174+
175+
.label {
176+
display: inline;
177+
padding: .2em .6em .3em;
178+
font-size: 75%;
179+
font-weight: 700;
180+
line-height: 1;
181+
color: #fff;
182+
text-align: center;
183+
white-space: nowrap;
184+
vertical-align: baseline;
185+
border-radius: .25em;
186+
background-color: #337ab7;
187+
}
188+
189+
.expand-toc {
190+
position: fixed;
191+
top: 2em;
192+
right: 5em;
193+
display: none;
194+
}
195+
196+
.container {
197+
max-width: 90rem;
198+
}
199+
200+
#book-search-input:focus {
201+
outline: none;
202+
}
203+
204+
.rest-api h5 {
205+
margin-top: .5em;
206+
margin-bottom: .5em;
207+
font-size: 1em;
208+
}
209+
210+
.rest-api tbody {
211+
display: table;
212+
width: 100%;
213+
background: white;
214+
}
215+
216+
.rest-api td {
217+
background: white;
218+
}
219+
220+
.rest-api .book-expand label {
221+
padding: 0rem 0rem;
222+
background: white;
223+
}
224+
225+
.rest-api .book-expand {
226+
background: white;
227+
}
228+
229+
.rest-api .book-expand .book-expand-head {
230+
background: white;
231+
}
232+
233+
.configuration td {
234+
background: white;
235+
}
236+
237+
.markdown table tr:nth-child(2n) {
238+
background: white;
239+
}

‎docs/assets/_fonts.scss

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Licensed to the Apache Software Foundation (ASF) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The ASF licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
18+
body {
19+
font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
20+
font-size: 14px;
21+
}
22+
23+
code {
24+
font-family: "Menlo", "Lucida Console", monospace;
25+
}

0 commit comments

Comments
 (0)