Skip to content

Commit 6a401d4

Browse files
XuanwoXuanwo
authoredDec 26, 2023
feat: Add website layout (apache#130)
* feat: Add website layout Signed-off-by: Xuanwo <[email protected]> * publish to rust.i.a.o Signed-off-by: Xuanwo <[email protected]> * Fix license Signed-off-by: Xuanwo <[email protected]> * Let's try mdbook action Signed-off-by: Xuanwo <[email protected]> * use cargo install Signed-off-by: Xuanwo <[email protected]> * disable section Signed-off-by: Xuanwo <[email protected]> * Add docs for website Signed-off-by: Xuanwo <[email protected]> * Fix license Signed-off-by: Xuanwo <[email protected]> * action approved Signed-off-by: Xuanwo <[email protected]> --------- Signed-off-by: Xuanwo <[email protected]>
1 parent 7d06a85 commit 6a401d4

10 files changed

+236
-1
lines changed
 

‎.asf.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ github:
4242
required_approving_review_count: 1
4343

4444
required_linear_history: true
45+
gh-pages:
46+
whatever: Just a placeholder to make it take effects
47+
4548
features:
4649
wiki: false
4750
issues: true
@@ -56,3 +59,7 @@ notifications:
5659
issues: issues@iceberg.apache.org
5760
pullrequests: issues@iceberg.apache.org
5861
jira_options: link label link label
62+
63+
publish:
64+
whoami: gh-pages
65+
hostname: rust.iceberg.apache.org

‎.github/workflows/website.yml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
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+
name: Website
19+
20+
on:
21+
push:
22+
branches:
23+
- main
24+
pull_request:
25+
branches:
26+
- main
27+
28+
concurrency:
29+
group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
30+
cancel-in-progress: true
31+
32+
jobs:
33+
build:
34+
runs-on: ubuntu-latest
35+
steps:
36+
- uses: actions/checkout@v4
37+
38+
- name: Setup mdBook
39+
uses: peaceiris/actions-mdbook@v1
40+
with:
41+
mdbook-version: '0.4.36'
42+
43+
- name: Build
44+
working-directory: website
45+
run: mdbook build
46+
47+
- name: Copy asf file
48+
run: cp .asf.yaml ./website/book/.asf.yaml
49+
50+
- name: Deploy to gh-pages
51+
uses: peaceiris/actions-gh-pages@v3.9.2
52+
if: github.event_name == 'push' && github.ref_name == 'main'
53+
with:
54+
github_token: ${{ secrets.GITHUB_TOKEN }}
55+
publish_dir: website/book
56+
publish_branch: gh-pages

‎.licenserc.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,6 @@ header:
2424
- 'LICENSE'
2525
- 'NOTICE'
2626
- '**/*.json'
27-
27+
# Generated content by mdbook
28+
- 'website/book'
2829
comment: on-failure

‎website/.gitignore

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
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+
book

‎website/README.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!--
2+
~ Licensed to the Apache Software Foundation (ASF) under one
3+
~ or more contributor license agreements. See the NOTICE file
4+
~ distributed with this work for additional information
5+
~ regarding copyright ownership. The ASF licenses this file
6+
~ to you under the Apache License, Version 2.0 (the
7+
~ "License"); you may not use this file except in compliance
8+
~ with the License. You may obtain a copy of the License at
9+
~
10+
~ http://www.apache.org/licenses/LICENSE-2.0
11+
~
12+
~ Unless required by applicable law or agreed to in writing,
13+
~ software distributed under the License is distributed on an
14+
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
~ KIND, either express or implied. See the License for the
16+
~ specific language governing permissions and limitations
17+
~ under the License.
18+
-->
19+
20+
# Iceberg Rust Website
21+
22+
## Setup
23+
24+
Install mdbook first
25+
26+
```shell
27+
cargo install mdbook
28+
```
29+
30+
## Preview
31+
32+
```shell
33+
mdbook serve
34+
```
35+
36+
## Build
37+
38+
```shell
39+
mdbook build
40+
```

‎website/book.toml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
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+
[book]
19+
authors = ["Iceberg Community"]
20+
language = "en"
21+
multilingual = false
22+
src = "src"
23+
title = "Iceberg Rust"
24+
25+
[output.html]
26+
git-repository-url = "https://github.com/apache/iceberg-rust"
27+
git-repository-icon = "fa-github"
28+
edit-url-template = "https://github.com/apache/iceberg-rust/edit/main/website/{path}"
29+
cname = "rust.iceberg.opendal.org"
30+
no-section-label = true

‎website/src/CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../CONTRIBUTING.md

‎website/src/SUMMARY.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<!--
2+
~ Licensed to the Apache Software Foundation (ASF) under one
3+
~ or more contributor license agreements. See the NOTICE file
4+
~ distributed with this work for additional information
5+
~ regarding copyright ownership. The ASF licenses this file
6+
~ to you under the Apache License, Version 2.0 (the
7+
~ "License"); you may not use this file except in compliance
8+
~ with the License. You may obtain a copy of the License at
9+
~
10+
~ http://www.apache.org/licenses/LICENSE-2.0
11+
~
12+
~ Unless required by applicable law or agreed to in writing,
13+
~ software distributed under the License is distributed on an
14+
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
~ KIND, either express or implied. See the License for the
16+
~ specific language governing permissions and limitations
17+
~ under the License.
18+
-->
19+
20+
- [Introduction](./introduction.md)
21+
22+
# User Guide
23+
24+
- [Install](./install.md)
25+
26+
# Developer Guide
27+
28+
- [Contributing](./CONTRIBUTING.md)

‎website/src/install.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!--
2+
~ Licensed to the Apache Software Foundation (ASF) under one
3+
~ or more contributor license agreements. See the NOTICE file
4+
~ distributed with this work for additional information
5+
~ regarding copyright ownership. The ASF licenses this file
6+
~ to you under the Apache License, Version 2.0 (the
7+
~ "License"); you may not use this file except in compliance
8+
~ with the License. You may obtain a copy of the License at
9+
~
10+
~ http://www.apache.org/licenses/LICENSE-2.0
11+
~
12+
~ Unless required by applicable law or agreed to in writing,
13+
~ software distributed under the License is distributed on an
14+
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
~ KIND, either express or implied. See the License for the
16+
~ specific language governing permissions and limitations
17+
~ under the License.
18+
-->
19+
20+
# Install
21+
22+
Add `iceberg` into `Cargo.toml` dependencies:
23+
24+
```toml
25+
iceberg = "0.2.0"
26+
```
27+
28+
iceberg is under active development, you may want to use the git version instead:
29+
30+
```toml
31+
iceberg = { git = "https://github.com/apache/iceberg-rust", rev = "commit-hash" }
32+
```

‎website/src/introduction.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!--
2+
~ Licensed to the Apache Software Foundation (ASF) under one
3+
~ or more contributor license agreements. See the NOTICE file
4+
~ distributed with this work for additional information
5+
~ regarding copyright ownership. The ASF licenses this file
6+
~ to you under the Apache License, Version 2.0 (the
7+
~ "License"); you may not use this file except in compliance
8+
~ with the License. You may obtain a copy of the License at
9+
~
10+
~ http://www.apache.org/licenses/LICENSE-2.0
11+
~
12+
~ Unless required by applicable law or agreed to in writing,
13+
~ software distributed under the License is distributed on an
14+
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
~ KIND, either express or implied. See the License for the
16+
~ specific language governing permissions and limitations
17+
~ under the License.
18+
-->
19+
20+
# Iceberg Rust
21+
22+
Iceberg Rust is a rust implementation for accessing iceberg tables.

0 commit comments

Comments
 (0)
Please sign in to comment.