Skip to content

Commit 66601ba

Browse files
andygroveandygrove
authored
docs: Publish version-specific user guides (#2269)
1 parent 78a2ef0 commit 66601ba

File tree

10 files changed

+186
-18
lines changed

10 files changed

+186
-18
lines changed

‎docs/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ build
1919
temp
2020
venv/
2121
.python-version
22+
comet-*

‎docs/build.sh‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,16 @@ rm -rf build 2> /dev/null
2323
rm -rf temp 2> /dev/null
2424
mkdir temp
2525
cp -rf source/* temp/
26+
27+
# move current user guide into "latest" directory
28+
mkdir temp/user-guide/latest
29+
mv temp/user-guide/*.md temp/user-guide/latest
30+
mv temp/user-guide/index.rst temp/user-guide/latest
31+
32+
# Add user guide from published releases
33+
python3 generate-versions.py
34+
35+
# Remove overview pages (this used to be part of the user guide but is now a top level page)
36+
find temp/user-guide -name overview.md -exec rm {} \;
37+
2638
make SOURCEDIR=`pwd`/temp html

‎docs/generate-versions.py‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
#!/usr/bin/python
2+
##############################################################################
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
##############################################################################
20+
21+
# This script clones release branches such as branch-0.9 and then copies the user guide markdown
22+
# for inclusion in the published documentation so that we publish user guides for released versions
23+
# of Comet
24+
25+
import os
26+
27+
for version in ["0.8", "0.9"]:
28+
os.system(f"git clone --depth 1 [email protected]:apache/datafusion-comet.git -b branch-{version} comet-{version}")
29+
os.system(f"mkdir temp/user-guide/{version}")
30+
os.system(f"cp -rf comet-{version}/docs/source/user-guide/* temp/user-guide/{version}")

‎docs/source/contributor-guide/development.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ under the License.
3030

3131
## Development Setup
3232

33-
1. Make sure `JAVA_HOME` is set and point to JDK using [support matrix](/docs/source/user-guide/installation.md)
33+
1. Make sure `JAVA_HOME` is set and point to JDK using [support matrix](/docs/source/user-guide/latest/installation.md)
3434
2. Install Rust toolchain. The easiest way is to use
3535
[rustup](https://rustup.rs).
3636

docs/source/user-guide/gluten_comparison.md renamed to docs/source/gluten_comparison.md

File renamed without changes.

‎docs/source/index.rst‎

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -35,29 +35,30 @@ Apache DataFusion Comet
3535
Apache DataFusion Comet is an Apache Spark plugin that uses Apache DataFusion
3636
as a native runtime to achieve improvement in terms of query efficiency and query runtime.
3737

38-
.. _toc.user-guide-links:
38+
.. _toc.main-links:
3939
.. toctree::
4040
:maxdepth: 1
41-
:caption: User Guide
41+
:caption: Overview:
42+
43+
Comet Overview <overview>
44+
Comparison with Gluten <gluten_comparison>
45+
46+
.. _toc.user-guide-links:
47+
.. toctree::
48+
:maxdepth: 2
49+
:caption: User Guides:
50+
:hidden:
4251

43-
Comet Overview <user-guide/overview>
44-
Installing Comet <user-guide/installation>
45-
Building From Source <user-guide/source>
46-
Supported Data Sources <user-guide/datasources>
47-
Supported Data Types <user-guide/datatypes>
48-
Supported Operators <user-guide/operators>
49-
Supported Expressions <user-guide/expressions>
50-
Configuration Settings <user-guide/configs>
51-
Compatibility Guide <user-guide/compatibility>
52-
Tuning Guide <user-guide/tuning>
53-
Metrics Guide <user-guide/metrics>
54-
Iceberg Guide <user-guide/iceberg>
55-
Kubernetes Guide <user-guide/kubernetes>
52+
Comet 0.10.0-SNAPSHOT <user-guide/latest/index>
53+
Comet 0.9.x <user-guide/0.9/index>
54+
Comet 0.8.x <user-guide/0.8/index>
55+
Comet 0.7.x <user-guide/0.7/index>
5656

5757
.. _toc.contributor-guide-links:
5858
.. toctree::
5959
:maxdepth: 1
6060
:caption: Contributor Guide
61+
:hidden:
6162

6263
Getting Started <contributor-guide/contributing>
6364
Comet Plugin Overview <contributor-guide/plugin_overview>
@@ -75,6 +76,7 @@ as a native runtime to achieve improvement in terms of query efficiency and quer
7576
.. toctree::
7677
:maxdepth: 1
7778
:caption: ASF Links
79+
:hidden:
7880

7981
Apache Software Foundation <https://apache.org>
8082
License <https://www.apache.org/licenses/>

docs/source/user-guide/overview.md renamed to docs/source/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ Spark ecosystem without requiring any code changes.
2828

2929
The following diagram provides an overview of Comet's architecture.
3030

31-
![Comet Overview](../_static/images/comet-overview.png)
31+
![Comet Overview](/_static/images/comet-overview.png)
3232

3333
## Architecture
3434

3535
The following diagram shows how Comet integrates with Apache Spark.
3636

37-
![Comet System Diagram](../_static/images/comet-system-diagram.png)
37+
![Comet System Diagram](/_static/images/comet-system-diagram.png)
3838

3939
## Feature Parity with Apache Spark
4040

‎docs/source/user-guide/0.8/index.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
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+
.. image:: _static/images/DataFusionComet-Logo-Light.png
19+
:alt: DataFusion Comet Logo
20+
21+
=======================
22+
Comet 0.8.x User Guide
23+
=======================
24+
25+
.. _toc.user-guide-links:
26+
.. toctree::
27+
:maxdepth: 1
28+
:caption: Comet 0.8.x User Guide
29+
30+
Installing Comet <installation>
31+
Building From Source <source>
32+
Supported Data Sources <datasources>
33+
Supported Data Types <datatypes>
34+
Supported Operators <operators>
35+
Supported Expressions <expressions>
36+
Configuration Settings <configs>
37+
Compatibility Guide <compatibility>
38+
Tuning Guide <tuning>
39+
Metrics Guide <metrics>
40+
Iceberg Guide <iceberg>
41+
Kubernetes Guide <kubernetes>

‎docs/source/user-guide/0.9/index.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
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+
.. image:: _static/images/DataFusionComet-Logo-Light.png
19+
:alt: DataFusion Comet Logo
20+
21+
=======================
22+
Comet 0.9.x User Guide
23+
=======================
24+
25+
.. _toc.user-guide-links:
26+
.. toctree::
27+
:maxdepth: 1
28+
:caption: Comet 0.9.x User Guide
29+
30+
Installing Comet <installation>
31+
Building From Source <source>
32+
Supported Data Sources <datasources>
33+
Supported Data Types <datatypes>
34+
Supported Operators <operators>
35+
Supported Expressions <expressions>
36+
Configuration Settings <configs>
37+
Compatibility Guide <compatibility>
38+
Tuning Guide <tuning>
39+
Metrics Guide <metrics>
40+
Iceberg Guide <iceberg>
41+
Kubernetes Guide <kubernetes>

‎docs/source/user-guide/index.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
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+
.. image:: _static/images/DataFusionComet-Logo-Light.png
19+
:alt: DataFusion Comet Logo
20+
21+
=======================
22+
Comet 0.10.0-SNAPSHOT User Guide
23+
=======================
24+
25+
.. _toc.user-guide-links:
26+
.. toctree::
27+
:maxdepth: 1
28+
:caption: Comet 0.10.0-SNAPSHOT User Guide
29+
30+
Installing Comet <installation>
31+
Building From Source <source>
32+
Supported Data Sources <datasources>
33+
Supported Data Types <datatypes>
34+
Supported Operators <operators>
35+
Supported Expressions <expressions>
36+
Configuration Settings <configs>
37+
Compatibility Guide <compatibility>
38+
Tuning Guide <tuning>
39+
Metrics Guide <metrics>
40+
Iceberg Guide <iceberg>
41+
Kubernetes Guide <kubernetes>

0 commit comments

Comments
 (0)