Skip to content

Commit dfcabb4

Browse files
andygroveandygrove
authored
docs: Improve site navigation (apache#2597)
1 parent 46828d2 commit dfcabb4

File tree

7 files changed

+137
-68
lines changed

7 files changed

+137
-68
lines changed

‎docs/source/gluten_comparison.md‎ renamed to ‎docs/source/about/gluten_comparison.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Comet relies on the full Spark SQL test suite (consisting of more than 24,000 te
6464
integration tests to ensure compatibility with Spark. Features that are known to have compatibility differences with
6565
Spark are disabled by default, but users can opt in. See the [Comet Compatibility Guide] for more information.
6666

67-
[Comet Compatibility Guide]: user-guide/latest/compatibility.md
67+
[Comet Compatibility Guide]: /user-guide/latest/compatibility.md
6868

6969
Gluten also aims to provide compatibility with Spark, and includes a subset of the Spark SQL tests in its own test
7070
suite. See the [Gluten Compatibility Guide] for more information.

‎docs/source/overview.md‎ renamed to ‎docs/source/about/index.md‎

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
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.
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.
1818
-->
1919

2020
# Comet Overview
@@ -53,7 +53,7 @@ There are two other major open-source Spark accelerators:
5353

5454
We have a detailed guide [comparing Apache DataFusion Comet with Apache Gluten].
5555

56-
Spark RAPIDS is a solution that provides hardware acceleration on NVIDIA GPUs. Comet does not require specialized
56+
Spark RAPIDS is a solution that provides hardware acceleration on NVIDIA GPUs. Comet does not require specialized
5757
hardware.
5858

5959
[comparing Apache DataFusion Comet with Apache Gluten]: gluten_comparison.md
@@ -62,4 +62,12 @@ hardware.
6262

6363
Refer to the [Comet Installation Guide] to get started.
6464

65-
[Comet Installation Guide]: user-guide/latest/installation.md
65+
[Comet Installation Guide]: /user-guide/latest/installation.md
66+
67+
```{toctree}
68+
:maxdepth: 1
69+
:caption: About
70+
:hidden:
71+
72+
Comparison with Gluten <gluten_comparison>
73+
```

‎docs/source/asf/index.md‎

Lines changed: 32 additions & 0 deletions
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+
# ASF Links
21+
22+
```{toctree}
23+
:maxdepth: 1
24+
:caption: ASF Links
25+
26+
Apache Software Foundation <https://apache.org>
27+
License <https://www.apache.org/licenses/>
28+
Donate <https://www.apache.org/foundation/sponsorship.html>
29+
Thanks <https://www.apache.org/foundation/thanks.html>
30+
Security <https://www.apache.org/security/>
31+
Code of conduct <https://www.apache.org/foundation/policies/conduct.html>
32+
```

‎docs/source/conf.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,10 @@
141141
myst_enable_extensions = ["colon_fence", "deflist", "tasklist"]
142142

143143
redirects = {
144-
"user-guide/overview.html": "../overview.html",
145-
"user-guide/gluten_comparison.html": "../gluten_comparison.html",
144+
"overview.html": "about/overview.html",
145+
"gluten_comparison.html": "about/gluten_comparison.html",
146+
"user-guide/overview.html": "../about/overview.html",
147+
"user-guide/gluten_comparison.html": "../about/gluten_comparison.html",
146148
"user-guide/compatibility.html": "latest/compatibility.html",
147149
"user-guide/configs.html": "latest/configs.html",
148150
"user-guide/datasource.html": "latest/datasource.html",

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
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+
# Comet Contributor Guide
21+
22+
```{toctree}
23+
:maxdepth: 2
24+
:caption: Contributor Guide
25+
26+
Getting Started <contributing>
27+
Comet Plugin Overview <plugin_overview>
28+
Development Guide <development>
29+
Debugging Guide <debugging>
30+
Benchmarking Guide <benchmarking>
31+
Adding a New Expression <adding_a_new_expression>
32+
Tracing <tracing>
33+
Profiling Native Code <profiling_native_code>
34+
Spark SQL Tests <spark-sql-tests.md>
35+
Roadmap <roadmap.md>
36+
Github and Issue Tracker <https://github.com/apache/datafusion-comet>
37+
```

‎docs/source/index.md‎

Lines changed: 5 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -97,52 +97,11 @@ shaping the future of Comet. Check out our
9797

9898
```{toctree}
9999
:maxdepth: 1
100-
:caption: Overview
100+
:caption: Index
101101
:hidden:
102102
103-
Comet Overview <overview>
104-
Comparison with Gluten <gluten_comparison>
105-
```
106-
107-
```{toctree}
108-
:maxdepth: 2
109-
:caption: User Guides
110-
:hidden:
111-
112-
0.12.0-SNAPSHOT <user-guide/latest/index>
113-
0.11.x <user-guide/0.11/index>
114-
0.10.x <user-guide/0.10/index>
115-
0.9.x <user-guide/0.9/index>
116-
0.8.x <user-guide/0.8/index>
117-
```
118-
119-
```{toctree}
120-
:maxdepth: 1
121-
:caption: Contributor Guide
122-
:hidden:
123-
124-
Getting Started <contributor-guide/contributing>
125-
Comet Plugin Overview <contributor-guide/plugin_overview>
126-
Development Guide <contributor-guide/development>
127-
Debugging Guide <contributor-guide/debugging>
128-
Benchmarking Guide <contributor-guide/benchmarking>
129-
Adding a New Expression <contributor-guide/adding_a_new_expression>
130-
Tracing <contributor-guide/tracing>
131-
Profiling Native Code <contributor-guide/profiling_native_code>
132-
Spark SQL Tests <contributor-guide/spark-sql-tests.md>
133-
Roadmap <contributor-guide/roadmap.md>
134-
Github and Issue Tracker <https://github.com/apache/datafusion-comet>
135-
```
136-
137-
```{toctree}
138-
:maxdepth: 1
139-
:caption: ASF Links
140-
:hidden:
141-
142-
Apache Software Foundation <https://apache.org>
143-
License <https://www.apache.org/licenses/>
144-
Donate <https://www.apache.org/foundation/sponsorship.html>
145-
Thanks <https://www.apache.org/foundation/thanks.html>
146-
Security <https://www.apache.org/security/>
147-
Code of conduct <https://www.apache.org/foundation/policies/conduct.html>
103+
Comet Overview <about/index>
104+
User Guide <user-guide/index>
105+
Contributor Guide <contributor-guide/index>
106+
ASF Links <asf/index>
148107
```

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
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+
# Comet User Guide
21+
22+
```{toctree}
23+
:maxdepth: 2
24+
:caption: User Guides
25+
26+
0.12.0-SNAPSHOT <latest/index>
27+
0.11.x <0.11/index>
28+
0.10.x <0.10/index>
29+
0.9.x <0.9/index>
30+
0.8.x <0.8/index>
31+
```

0 commit comments

Comments
 (0)